You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASING.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,31 +17,31 @@ Release process uses GitHub actions and involves:
17
17
- Remove the "-SNAPSHOT" suffix from the version and create scm tag
18
18
- Create a GitHub release and upload artifacts
19
19
- If patch release, delete the patch branch
20
-
- For a formal release only, increment snapshot version on a branch and open a pull request
20
+
- For a formal release only, increment snapshot version on a branch and open a pull request
21
21
- Publish the artifacts to GitHub Maven Repo
22
22
23
-
The release process used for this repository creates a branch for every release that is prefixed with `release/`. Tags are not added nor are releases performed on the `master` branch.
24
-
The `master` branch is the target for merging new commits and for development releases (-SNAPSHOT) only. All patches will originate using a `patch/` prefixed branch and once complete
25
-
a new `release/` branch will be created.
23
+
The release process used for this repository creates a branch for every release that is prefixed with `release/`. Tags are not added nor are releases performed on the `main` branch.
24
+
The `main` branch is the target for merging new commits and for development releases (-SNAPSHOT) only. All patches will originate using a `patch/` prefixed branch and once complete
25
+
a new `release/` branch will be created.
26
26
27
27
## Versioning
28
28
29
-
While not strictly enforced, versioning generally follows the [Semantic Versioning](https://semver.org/) Guide.
29
+
While not strictly enforced, versioning generally follows the [Semantic Versioning](https://semver.org/) Guide.
30
30
31
31
## Release Types
32
32
33
33
### Formal Release
34
34
35
-
Formal release for the project and is intended to be stable.
35
+
Formal release for the project and is intended to be stable.
36
36
37
37
```
38
38
Action: `Maven: Release`
39
39
Options:
40
-
- From: `Branch: master`
40
+
- From: `Branch: main`
41
41
- Type: `Release`
42
42
- Suffix: Leave blank
43
43
```
44
-
Creates a branch called `release/<version>` and performs release. One commit is added to a branch called `action/<version>` only to increment to the next snapshot version, and
44
+
Creates a branch called `release/<version>` and performs release. One commit is added to a branch called `action/<version>` only to increment to the next snapshot version, and
45
45
a pull request is created that needs to be approved and merged to finish the release process.
46
46
47
47
@@ -52,7 +52,7 @@ Releases may have bugs or vulnerabilities with a high enough severity that requi
52
52
#### Create Patch Branch
53
53
54
54
Creating a patch branch can be done manually or using the GitHub action. The action was added as a convenience, and is not required as part
55
-
of the workflow.
55
+
of the workflow.
56
56
57
57
Note: When manually creating a patch branch, the name must start with `patch/` and must be based on a release branch, i.e. `release/<version>`.
58
58
```
@@ -66,7 +66,7 @@ The user can specify one or more commit hashes, separated by spaces, to cherry-p
66
66
67
67
#### Release Patch
68
68
69
-
Patch release for the project that intended to fix one or more bugs/vulnerabilities for a release. Patches are not intended for new functionality
69
+
Patch release for the project that intended to fix one or more bugs/vulnerabilities for a release. Patches are not intended for new functionality
70
70
unless it is directly supporting a bugfix/hotfix.
71
71
72
72
```
@@ -93,7 +93,7 @@ Options:
93
93
- Suffix: `-M1` <- this is just an example it can be anything, e.g. `M1` OR `-MILESTONE1`
94
94
```
95
95
96
-
Creates a branch called `release/<version><suffix>`, i.e. `release/8.0.0-M1`, and performs release. No commits or pull request are created to increment
96
+
Creates a branch called `release/<version><suffix>`, i.e. `release/8.0.0-M1`, and performs release. No commits or pull request are created to increment
97
97
to the next version.
98
98
99
99
## Publishing a Release
@@ -109,11 +109,11 @@ Pushes release artifacts to a repo using `maven deploy`.
109
109
110
110
## Publishing a Release to Maven Central
111
111
112
-
Policy does not allow publishing to maven central via Action and is only authorized to be perforemd by specific individuals.
112
+
Policy does not allow publishing to maven central via Action and is only authorized to be perforemd by specific individuals.
113
113
114
114
Using the `oss` profile will make the artifacts available here: [Sonatype/Maven Central](https://central.sonatype.com/artifact/gov.nsa/emissary)
115
115
116
116
In order for the following profile to work authorization is needed to publish to the gov.nsa maven group as well as having GPG signing configured in maven settings.
0 commit comments