File: release_procedure.md

package info (click to toggle)
apbs 3.4.1-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 199,188 kB
  • sloc: ansic: 284,988; cpp: 60,416; fortran: 44,896; xml: 13,895; sh: 13,838; python: 8,105; yacc: 2,922; makefile: 1,428; f90: 989; objc: 448; lex: 294; awk: 266; sed: 205; java: 134; csh: 79
file content (44 lines) | stat: -rw-r--r-- 1,977 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
APBS Release Procedure
-----------------------
 1. Change Version Number
	 - [ ] Edit [VERSION]([https://github.com/Electrostatics/apbs/blob/main/apbs/VERSION)
		Increment the value after the comment block, which is in the form
	     M_m_u
	     Where:
		 - M is the Major version - increment if there are breaking changes or dropping support for previous features
		 - m is the Minor version - increment for new features added
		 - u is the Micro version - increment for adding small changes like new tests or fixing small bugs

 2. Update the Releases document
	 - [ ] Edit [docs/releases.rst]([https://github.com/Electrostatics/apbs/blob/main/apbs/docs/releases.rst)
	   - Document major/minor changes for this release
   
 3. Update License info
	   - [ ] Update license dates and information in source files
	   - In apbs/src edit all .c source files and all .h header files, update dates
  
 4. Create a Pull Request (PR)
     - [ ] Create a new [Pull Request](https://github.com/Electrostatics/apbs/pulls)
		 - Base branch should be `release`
		 - Source branch should be `main`
		 - Briefly describe the changes included

 5. Check tests
     - Go to the [Actions](https://github.com/Electrostatics/apbs/actions) tab in GitHub
     - Tests are performed for three target platforms:
       - Ubuntu
	   - MacOSX
	   - Windows
     - [ ] Ensure that the builds and associated tests were successful
	 - [ ] Ensure that the use tests were successful
	 - [ ] Ensure that the build artifacts were uploaded to the action

 6. Merge the PR
	 - [ ] Ensure that the [Release](https://github.com/Electrostatics/apbs/releases) is correctly created
	 - [ ] Ensure that the builds and associated tests were successful
	 - [ ] Ensure that the use tests were successful
	 - [ ] Ensure that the build artifacts were uploaded to the Release

 7. Update http://www.poissonboltzmann.org/apbs/release-history with new release information.

 8. Pat yourself on the back for a job well done!