@@ -41,35 +41,35 @@ There are sometimes where we are not sure whether we want or can solve an issue.
4141There are also a bunch of ` relates-to ` labels that can be used to further categorise issues. This is helpful in projects
4242with a lot of issues, or projects where different people work on different parts or modules.
4343
44- The majority of the issues are defined in the
44+ The majority of the issues are defined in the
4545[ management] ( https://github.com/micronaut-projects/management/blob/master/labels.tf ) repo, and propagated via Terraform.
4646If you want new labels:
4747
4848* If they can be beneficial to several repos, send a pull request to the management repo.
4949* If they are repo-specific, just go ahead and create them with the GitHub UI.
5050
51- Finally, issues (especially bugs) should be prioritised with either ` priority: high ` , ` priority: medium ` or
51+ Finally, issues (especially bugs) should be prioritised with either ` priority: high ` , ` priority: medium ` or
5252` priority: low ` . Checkout the
5353[ Issue Priority Labels] ( https://github.com/micronaut-projects/micronaut-core/wiki/Issue-Priority-Labels ) document for
5454guidelines about when to use each of them.
5555
5656## Review pull requests
5757
58- Pull requests, regardless of whether they are created by internal or external contributors, should meet the following
58+ Pull requests, regardless of whether they are created by internal or external contributors, should meet the following
5959criteria:
6060
6161* All the GitHub checks are passing (CLA signed and builds passing).
6262* Code has a minimum quality, it uses the Micronaut APIs correctly, doesn't contain bad smells, etc. Essentially, the
6363 type of things you would review in every other software project.
6464* Contains tests.
6565* Includes documentation.
66- * If it closes any issues,
66+ * If it closes any issues,
6767 [ they should be linked] ( https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue )
6868 either using closing keywords, or manually.
6969
70- Regarding the target branch, backwards-compatible bug fixes and improvements typically target the default branch,
70+ Regarding the target branch, backwards-compatible bug fixes and improvements typically target the default branch,
7171backwards-compatible enhancements target the next minor version branch, and breaking changes target the next major version
72- branch. Check the
72+ branch. Check the
7373[ Micronaut Module Versioning] ( https://github.com/micronaut-projects/micronaut-core/wiki/Micronaut-Module-Versioning )
7474document for more information.
7575
@@ -78,7 +78,7 @@ patch/minor release we don't leak breaking changes. Check the
7878[ Micronaut Module Branch Naming] ( https://github.com/micronaut-projects/micronaut-core/wiki/Micronaut-Module-Branch-Naming )
7979document for more information.
8080
81- Note that
81+ Note that
8282[ Micronaut Core and Starter] ( https://github.com/micronaut-projects/micronaut-core/wiki/Micronaut-Core-and-Starter-Branching-Strategy )
8383follow a slightly different strategy.
8484
@@ -93,17 +93,17 @@ All Micronaut repos have 2 dependency upgrade checking mechanism:
9393 those defined in ` gradle.properties ` . It will also send different PRs for the same version upgrade if the artifact ID
9494 is different. For example, if you have ` com.example:client:1.0 ` and ` com.example:server:1.0 ` , and a new 1.1 version
9595 arrives for both, it will send 2 PRs, where they should both be upgraded at the same time.
96-
96+
97972 . To overcome those disadvantages, we have our own dependency upgrade solution based on the
9898 [ Gradle Use Latest Versions Plugin] ( https://github.com/patrikerdes/gradle-use-latest-versions-plugin ) . It runs daily
9999 during weekdays.
100-
100+
101101The consequence of having both approaches in place is that we get multiple dependency upgrade PRs: one created by
102102` micronaut-build ` via our automation, and one or many (one per dependency) created by Dependabot. When merging those, it
103- is better to prefer the ` micronaut-build ` ones, if possible, for 2 reasons: a) they attempt to upgrade multiple dependencies
103+ is better to prefer the ` micronaut-build ` ones, if possible, for 2 reasons: a) they attempt to upgrade multiple dependencies
104104in a single PR, which creates less noise in the Git history; b) Once you merge that, Dependabot will react and automatically
105105close its own PRs if the dependecy is up-to-date.
106-
106+
107107When an upgrade to a new version arrives, we need to be careful when merging, so that we don't introduce an
108108unnecessary upgrade burden on our users. Read the
109109[ Module Upgrade Strategy] ( https://github.com/micronaut-projects/micronaut-core/wiki/Module-Upgrade-Strategy ) for more
@@ -157,7 +157,7 @@ Note that it is perfectly possible to have new workflows that aren't part of the
157157The release process is highly automated and normally involves just publishing a GitHub release. But before you get there,
158158there are some parts you need to understand first.
159159
160- First of all, all the repos have an automatic changelog generation mechanism: when a change is made to the repo
160+ First of all, all the repos have an automatic changelog generation mechanism: when a change is made to the repo
161161(a push event), it creates (or updates if there is already one) a draft release, calculating the next patch version. The
162162release notes will contain pull requests merged and issues closed since the last release.
163163
@@ -168,21 +168,21 @@ If you are publishing a milestone or release candidate, check the pre-release ch
168168
169169Note that the release tags must be preceded with ` v ` , e.g.: ` v1.2.3 ` .
170170
171- Once you publish the GitHub release, the
171+ Once you publish the GitHub release, the
172172[ Release GitHub Action workflow] ( https://github.com/micronaut-projects/micronaut-project-template/blob/master/.github/workflows/release.yml )
173173will kick off, performing the following steps:
174174
175- * Pre-release: sets the ` projectVersion ` property in ` gradle.properties ` to the release version, and commit and pushes
175+ * Pre-release: sets the ` projectVersion ` property in ` gradle.properties ` to the release version, and commit and pushes
176176 the result.
177177* Generates documentation guide and publishes it to the ` gh-pages ` branch.
178178* Sends a pull request to Core to update the BOM.
179- * Post-release:
179+ * Post-release:
180180 * Determines the next patch version, and sets it as a ` SNAPSHOT ` version.
181181 * Closes the milestone that matches the release version, and creates a new one for the next patch.
182182
183183If everything goes well, you now need to manually trigger the Maven Central publishing workflow via the GitHub UI.
184184
185- If there is an issue with the release, it's important not to trigger the Maven Central publishing workflow because once
185+ If there is an issue with the release, it's important not to trigger the Maven Central publishing workflow because once
186186we publish a version to Maven Central we cannot change or remove it anymore.
187187
188188There are some properties in ` gradle.properties ` that affect the release process:
@@ -192,19 +192,19 @@ There are some properties in `gradle.properties` that affect the release process
192192* ` bomProperty ` : in Micronaut Core's ` gradle.properties ` , the property that represents this module's version.
193193* ` bomProperties ` : if needed, additional properties for the BOM pull request.
194194
195- For example, assuming a module has the release ` 1.0.0 ` as the latest version published, which was included in the
195+ For example, assuming a module has the release ` 1.0.0 ` as the latest version published, which was included in the
196196Micronaut ` 2.2.0 ` BOM. If the next version you want to publish is:
197197
198198* A new patch release (` 1.0.1 ` ): simply publish the existing draft release.
199- * A new minor release (` 1.1.0 ` ):
199+ * A new minor release (` 1.1.0 ` ):
200200 * Before the release, push a ` 1.0.x ` branch off ` master ` .
201201 * Bump the version in master to ` 1.1.0-SNAPSHOT ` .
202202 * Set the ` githubCoreBranch ` property to ` 2.3.x ` (or ` 3.0.x ` if it will be the next one).
203203 * Edit the draft release setting the version to ` 1.1.0 ` in the release title, body, tag, etc.
204204 * Publish the release.
205- * A new major release (` 2.0.0 ` ):
205+ * A new major release (` 2.0.0 ` ):
206206 * Before the release, push a ` 1.0.x ` branch off ` master ` .
207207 * Bump the version in master to ` 2.0.0-SNAPSHOT ` .
208208 * Set the ` githubCoreBranch ` property to ` 3.0.x ` (or ` 2.3.x ` if this new major version doesn't introduce breaking changes).
209209 * Edit the draft release setting the version to ` 2.0.0 ` in the release title, body, tag, etc.
210- * Publish the release.
210+ * Publish the release.
0 commit comments