Skip to content

Commit 1d22e75

Browse files
committed
Modified release doc.
1 parent a65dbd2 commit 1d22e75

10 files changed

+17
-22
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ To facilitate easier debugging and logging, we have made our user agent header e
6363
### Run it
6464
Once installed, run the application and you will see the following screen:
6565

66-
![Application-Windows](/docs/Application-Windows.png)
66+
![Application-Windows](/docs/images/Application-Windows.png)
6767

6868
There are two primary options to set:
6969

build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ allprojects {
4141

4242
// Per the axion-release plugin, this computes the project version based
4343
// on the most recent tag in the repo.
44-
version "7.1.1"
44+
version scmVersion.version
4545

4646
repositories {
4747
mavenCentral()

docs/ACCEPTANCE_TESTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ The source id can be used to find all datasets versions of a source on the [Mobi
102102
## What do we do with the results?
103103
We follow this process:
104104

105-
<img src="/docs/Acceptance-test-process.jpg" width="750">
105+
<img src="/docs/images/Acceptance-test-process.jpg" width="750">
106106

107107
## Performance metrics within the acceptance reports
108108

docs/BRANCHING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
- A maintenance is created if some bug has to be corrected before the next scheduled release.
1717
- As an example see [#1663](https://github.com/MobilityData/gtfs-validator/pull/1653) in the gtfs-validator repository.
1818

19-
![](BranchingDiagram.png)
19+
![](images/BranchingDiagram.png)
2020

2121
## Feature/fix branches
2222

docs/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ This process is described in more detail in the GitHub documentation [**Contribu
8888

8989
This image shows the tests implemented in the Pull Request process.
9090

91-
<img src="/docs/Pull-Request-process.jpg" width="700">
91+
<img src="/docs/images/Pull-Request-process.jpg" width="700">
9292

9393
## Pull Request comments and reviews
9494
Reviewing Pull Requests is a great way to get familiar with the code & architecture of this tool, and to make sure a functionality meets your needs. Each Pull Request has to be approved by at least one one core developer, but having community members helping with this process is significant for the MobilityData team. Additionally, having the eyes of people from different expertise and backgrounds on a contribution makes it higher quality (nobody can think of everything!).
@@ -131,7 +131,7 @@ A critical step in troubleshooting is being able to reproduce the problem. Instr
131131

132132
The acceptance test is a key part of the Pull Request process. More information about this test is available in the [ACCEPTANCE_TEST.md](/docs/ACCEPTANCE_TESTS.md) file.
133133

134-
<img src="/docs/Acceptance-test-process.jpg" width="650">
134+
<img src="/docs/images/Acceptance-test-process.jpg" width="650">
135135

136136
**How to run tests locally?**
137137

docs/RELEASE.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -63,25 +63,20 @@ Uploaded artefacts have versions.
6363

6464
* Typically when doing a release the publish_assets.yml Github action is automatically run.
6565
This will upload some assets
66-
to be available on the release page itself (see for example [Release 4.1.0 assets](https://github.com/MobilityData/gtfs-validator/releases/tag/v4.1.0#:~:text=7%20other%20contributors-,Assets,-6))
66+
to be available on the release page itself (see for example [Release 7.1.0 assets](https://github.com/MobilityData/gtfs-validator/releases/tag/v7.1.0))
6767

6868

69-
* This Github action also publishes to Sonatype. This is used as a staging area before making the arftefacts available via Maven Central.
70-
* See [Sonatype Staging Repositories](https://s01.oss.sonatype.org/#stagingRepositories) (login required)
71-
* There should be a repository in the list with name orgmobilitydata-####. This is automatically created by Sonatype when files are uploaded.
69+
* This Github action also publishes to Maven Central.
70+
* See [Maven Sentral Repository Deployments](https://central.sonatype.com/publishing/deployments) (login required)
71+
* If the Github action was successful, there should be components in this page:
7272

73-
![image](https://github.com/MobilityData/gtfs-validator/assets/106176106/f08a24ec-addb-4d63-840d-24297c505822)
73+
![image](images/Maven-central-deployments.png)
7474

75-
76-
* You can browse the repo content to make sure everything is there. In particular there should be the jars for the code, jars for javadoc, for sources, and files for the maven pom.
75+
* You can browse the different components, look at the components files, make sure the version is correct, etc.
7776
* Everything should be signed, as evidenced by the presence of files with extension .sha1, .sha256, .sha512 etc.
78-
* Also make sure the version is correct.
79-
* You then need to manually close the repo. Doing this will trigger acceptance tests for Maven Central.
80-
81-
![image](https://github.com/MobilityData/gtfs-validator/assets/106176106/1d8916c6-a640-43cf-9658-82193d127b1d)
82-
83-
* Once the repository is closed it becomes available for inclusion in projects for testing. The URL to use as repository in your gradle or maven configuration files can be found in the summary for the repo.
84-
![image](https://github.com/MobilityData/gtfs-validator/assets/106176106/c809c1ca-67d7-4c45-bfa5-47441e163d2f)
77+
* If for some reason you think the components should not be published, you can press the `Drop` button for each component.
78+
* If you are satisfied, you can press the `Publish` button for each of the components.
79+
* The result should be that the components are made available in Maven Central. See [Maven Central Repository](https://repo1.maven.org/maven2/org/mobilitydata/gtfs-validator/) for the published components.
80+
* They will disappear from the page as you publish or drop them.
8581

86-
* Once satisfied with the testing, the repo can be released to Maven Central.
87-
* Note that once a release is deployed on Maven Central, it cannot be removed or modified. If problems are detected after this stage, a new release with a different version has to be created.
82+
* Note that once a release is published on Maven Central, it cannot be removed or modified. If problems are detected after this stage, a new release with a different version has to be created.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)