Skip to content

Commit ff1f19f

Browse files
committed
Format with Prettier
Prettier is the industry-standard formatter for web development (much like black). In this case, just standardize whitespace and unordered list characters.
1 parent 0b68ff0 commit ff1f19f

File tree

1 file changed

+29
-32
lines changed

1 file changed

+29
-32
lines changed

RELEASING.md

Lines changed: 29 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You will also need the following credentials:
1717

1818
- a configured GPG key in `git` in order to create signed tags
1919
- pypi credentials for use with `twine` (e.g. a token in `~/.pypirc`) valid for
20-
publishing `globus-compute-sdk` and `globus-compute-endpoint`
20+
publishing `globus-compute-sdk` and `globus-compute-endpoint`
2121

2222
## Alpha releases
2323

@@ -120,8 +120,8 @@ You will also need the following credentials:
120120

121121
Before building the packages:
122122

123-
* ensure that the release itself, either the alpha or prod versions, is published on PyPI.
124-
* ⚠️ The Jenkins build pages need to be accessed via VPN.
123+
- ensure that the release itself, either the alpha or prod versions, is published on PyPI.
124+
- ⚠️ The Jenkins build pages need to be accessed via VPN.
125125

126126
#### Build Process
127127

@@ -134,21 +134,21 @@ Our alpha builds will go to the `unstable` repo, and production packages goes to
134134
the `testing` and `stable` repos.
135135

136136
After this build process for production, the testing and stable packages will reside
137-
in an internal globus 'holding' repo. GCS manages the infrastructure so we need to
138-
run another Jenkins build to push it to live if GCS is not doing a release the same week which also pushes our packages. See last pipeline step below.
139-
140-
* Example of unstable repo:
141-
* https://downloads.globus.org/globus-connect-server/unstable/rpm/el/9/x86_64/
142-
* Directory of testing images:
143-
* https://builds.globus.org/downloads.globus.org/globus-connect-server/testing/rpm/el/8/x86_64/
144-
* Stable repo:
145-
* The images will be in the below build directory after we finish our build process, but not public:
146-
* https://builds.globus.org/downloads.globus.org/globus-connect-server/stable/rpm/el/8/x86_64/
147-
* After GCS push during deploy day (or if we ping them to do so), the public images will be located at:
148-
* https://downloads.globus.org/globus-connect-server/stable/rpm/el/9/x86_64/
137+
in an internal globus 'holding' repo. GCS manages the infrastructure so we need to
138+
run another Jenkins build to push it to live if GCS is not doing a release the same week which also pushes our packages. See last pipeline step below.
139+
140+
- Example of unstable repo:
141+
- https://downloads.globus.org/globus-connect-server/unstable/rpm/el/9/x86_64/
142+
- Directory of testing images:
143+
- https://builds.globus.org/downloads.globus.org/globus-connect-server/testing/rpm/el/8/x86_64/
144+
- Stable repo:
145+
- The images will be in the below build directory after we finish our build process, but not public:
146+
- https://builds.globus.org/downloads.globus.org/globus-connect-server/stable/rpm/el/8/x86_64/
147+
- After GCS push during deploy day (or if we ping them to do so), the public images will be located at:
148+
- https://downloads.globus.org/globus-connect-server/stable/rpm/el/9/x86_64/
149149
[publishResults.groovy line 85](https://github.com/globusonline/gcs-build-scripts/blob/168617a0ccbb0aee7b3bee04ee67940bbe2a80f6/vars/publishResults.groovy#L85)
150150

151-
1. (Access on VPN) For each release, confirm that the Pipeline -> SCM -> Branch Specifier is `${BRANCH_OR_TAG}` in [Build Configuration](https://builds.globus.org/jenkins/job/BuildGlobusComputeAgentPackages/configure). (This may become an unnecessary step over time.)
151+
1. (Access on VPN) For each release, confirm that the Pipeline -> SCM -> Branch Specifier is `${BRANCH_OR_TAG}` in [Build Configuration](https://builds.globus.org/jenkins/job/BuildGlobusComputeAgentPackages/configure). (This may become an unnecessary step over time.)
152152

153153
1. Enter the alpha or prod release name e.g. v3.14.0a0 or v3.14.0 in the input textbox of the [Build with Parameters](https://builds.globus.org/jenkins/job/BuildGlobusComputeAgentPackages/build?delay=0sec) page.
154154

@@ -157,37 +157,34 @@ run another Jenkins build to push it to live if GCS is not doing a release the s
157157
1. Wait 15-30 minutes and confirm that the [build is green](https://builds.globus.org/jenkins/job/BuildGlobusComputeAgentPackages/)
158158

159159
1. For production release cycles where there is also a GCS release, if we push our packages before they do, skip the following (also not necessary for alpha releases)
160+
- If there isn't a concurrent GCS release, or if GCS finishes their deploy before we finish building our packages, we need to manually run the downloads sync Jenkins script:
160161

161-
* If there isn't a concurrent GCS release, or if GCS finishes their deploy before we finish building our packages, we need to manually run the downloads sync Jenkins script:
162-
163-
* https://builds.globus.org/jenkins/view/all/job/Synchronize%20GCSv5%20Stable/build?delay=0sec
164-
* Leave `SYNC_WHEELS_ONLY` unchecked
162+
- https://builds.globus.org/jenkins/view/all/job/Synchronize%20GCSv5%20Stable/build?delay=0sec
163+
- Leave `SYNC_WHEELS_ONLY` unchecked
165164

166165
#### Old Build Instructions
167166

168167
(Previously) As a temporary workaround, we needed to add a few lines to manually set some
169168
env variables in our [JenkinsFile](https://github.com/globus/globus-compute/blob/743fa1e398fd40a00efb5880c55e3fa6e47392fc/compute_endpoint/packaging/JenkinsFile#L24) before triggering the build, as detailed below.
170169

171170
1. Notes
171+
- Example of unstable repo:
172+
- https://downloads.globus.org/globus-connect-server/unstable/rpm/el/9/x86_64/
172173

173-
* Example of unstable repo:
174-
* https://downloads.globus.org/globus-connect-server/unstable/rpm/el/9/x86_64/
175-
176-
* Directory of testing images:
177-
* https://builds.globus.org/downloads.globus.org/globus-connect-server/testing/rpm/el/8/x86_64/
174+
- Directory of testing images:
175+
- https://builds.globus.org/downloads.globus.org/globus-connect-server/testing/rpm/el/8/x86_64/
178176

179-
* Stable repo:
180-
* The images will be in the below build directory after we finish our build process, but not public:
181-
* https://builds.globus.org/downloads.globus.org/globus-connect-server/stable/rpm/el/8/x86_64/
177+
- Stable repo:
178+
- The images will be in the below build directory after we finish our build process, but not public:
179+
- https://builds.globus.org/downloads.globus.org/globus-connect-server/stable/rpm/el/8/x86_64/
182180

183-
* After GCS push during deploy day (or if we ping them to do so), the public images will be located at:
184-
* https://downloads.globus.org/globus-connect-server/stable/rpm/el/9/x86_64/
185-
[publishResults.groovy line 85](https://github.com/globusonline/gcs-build-scripts/blob/168617a0ccbb0aee7b3bee04ee67940bbe2a80f6/vars/publishResults.groovy#L85)
181+
- After GCS push during deploy day (or if we ping them to do so), the public images will be located at: \* https://downloads.globus.org/globus-connect-server/stable/rpm/el/9/x86_64/
182+
[publishResults.groovy line 85](https://github.com/globusonline/gcs-build-scripts/blob/168617a0ccbb0aee7b3bee04ee67940bbe2a80f6/vars/publishResults.groovy#L85)
186183

187184
1. (Access on VPN) Click the [build button here](https://builds.globus.org/jenkins/job/BuildGlobusComputeAgentPackages/build?delay=0sec)
188185

189186
1. Wait 20-30 minutes and confirm that the [build is green](https://builds.globus.org/jenkins/job/BuildGlobusComputeAgentPackages/)
190187

191188
1. For production release, we will have finished the build before the GCS
192-
team, and can notify them that our build is complete. They then will
189+
team, and can notify them that our build is complete. They then will
193190
publish all packages when they finish their builds, which includes ours.

0 commit comments

Comments
 (0)