Skip to content

Commit a7f90b8

Browse files
committedNov 4, 2024
updated release procedure documentation
1 parent 78bb356 commit a7f90b8

File tree

1 file changed

+18
-26
lines changed

1 file changed

+18
-26
lines changed
 

‎doc/RELEASING.md

+18-26
Original file line numberDiff line numberDiff line change
@@ -21,37 +21,29 @@ release version 2.0.123:
2121
- people who reported issues
2222
- people who created pull requests
2323
- people who suggested code that was implemented
24-
2. Update the log4net.csproj file with this new version
25-
3. Build release artifacts with `npm run release`
24+
2. Build release artifacts with `npm run release`
2625
- if this doesn't work, you may need to `npm ci` first!
27-
- currently, this _must_ happen on a windows machine because of older
28-
.net framework requirements which cannot be met on a Linux machine
29-
(or at least, I haven't figured out how - in particular CF)
30-
4. Sign release artifacts (zips & nupkg) under `build/artifacts`
31-
- eg `gpg --armor --output log4net-2.0.123.nupkg.asc --detach-sig log4net-2.0.123.nupkg`
32-
- there is an accompanying `sign-log4net-libraries.sh/ps1` under scripts which you could invoke if you cd
33-
into the `build/artifacts` folder
34-
- I build on Windows and sign on Linux as my build machine belongs to my company
35-
and I don't want to store keys there. Always protect your keys fervently!
36-
5. Clone out the log4net doc repo (https://github.com/apache/logging-log4net-site)
26+
3. Sign release artifacts (zips & nupkg) under `build/artifacts`
27+
- `./scripts/sign-log4net-libraries.sh/ps1`
28+
4. Clone out the log4net doc repo (https://github.com/apache/logging-log4net-site)
3729
- check out the `asf-staging` branch
3830
- create a folder which includes the version, eg `log4net-2.0.123`
39-
6. Copy the contents of `target/site` from this repo into the folder created in (5)
31+
5. Copy the contents of `target/site` from this repo into the folder created in (5)
4032
- remember to either update or link in sdk docs from a prior release
41-
7. Update the symlinks in the base of the docs repo, ie:
33+
6. Update the symlinks in the base of the docs repo, ie:
4234
- 2.0.x -> 2.0.123
4335
- 2.x -> 2.0.123
44-
8. update the `doap_log4net.rdf` to point to the new release
36+
7. update the `doap_log4net.rdf` to point to the new release
4537
- (copy-paste-modify an existing release)
46-
9. update the `.htaccess` file
38+
8. update the `.htaccess` file
4739
- the trailing RewriteRule should point to the new log4net-2.0.123 folder
48-
10. push the `asf-staging` branch to github and wait a bit
49-
- after a minute or two, check the updates at https://logging.staged.apache.org/log4net
50-
- are you seeing the correct releases page?
51-
- download links should (at this point) not work
52-
11. create an rc-releasd at GitHub with a tag like `rc/2.0.123-rc1`
40+
9. push the `asf-staging` branch to github and wait a bit
41+
- after a minute or two, check the updates at https://logging.staged.apache.org/log4net
42+
- are you seeing the correct releases page?
43+
- download links should (at this point) not work
44+
10. create an rc-releasd at GitHub with a tag like `rc/2.0.123-rc1`
5345
- attach all the files from the build/artifacts folder, _including signatures_
54-
12. get the artifacts in build/artifacts up to https://downloads.apache.org/logging/log4net/
46+
11. get the artifacts in build/artifacts up to https://downloads.apache.org/logging/log4net/
5547
- `svn co https://dist.apache.org/repos/dist/dev/logging -N apache-dist-logging-dev`
5648
- `cd apache-dist-logging-dev`
5749
- `svn up log4net`
@@ -61,10 +53,10 @@ release version 2.0.123:
6153
- `svn add *`
6254
- `svn commit -m 'log4net 2.0.123'`
6355
- check https://dist.apache.org/repos/dist/dev/logging/log4net/2.0.123/
64-
13. raise a vote on the log4net mailing list (dev@logging.apache.org) - see MailTemplate.txt
65-
14. wait
66-
15. when the vote has 3 or more +1's, it's time to go live!
67-
16. copy the apache artifacts (binary and source) to the release svn repo and commit
56+
12. raise a vote on the log4net mailing list (dev@logging.apache.org) - see MailTemplate.txt
57+
13. wait
58+
14. when the vote has 3 or more +1's, it's time to go live!
59+
15. copy the apache artifacts (binary and source) to the release svn repo and commit
6860
- `svn co https://dist.apache.org/repos/dist/release/logging -N apache-dist-logging-release`
6961
- `cd apache-dist-logging-release`
7062
- `svn up log4net`

0 commit comments

Comments
 (0)
Please sign in to comment.