Skip to content

Commit 3f07f3e

Browse files
committed
Merge pull request #2421 from alphagov/clean-up-formatting-in-docs
Update links to Jenkins and add links to github repos in READMEs
2 parents 562aac1 + 3cc022f commit 3f07f3e

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

doc/archiving.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ If a flow needs to be removed urgently then it be can archived quickly by changi
99
Once a flow has been removed the artefact will no longer register itself when the Smart Answers application is released.
1010

1111
You will then need to:
12-
1. Archive the artefact in Panopticon (same process as other types of content)
13-
2. Add a redirect `router-data` for the artefact slub. This should be a `prefix` route, so all parts of the Smart Answer URL are matched and preserved. ([This is a good example](https://github.gds/gds/router-data/blob/master/data/slug-changes.csv#L623))
12+
13+
1. Archive the artefact in [Panopticon](https://github.com/alphagov/panopticon) (same process as other types of content)
14+
2. Add a redirect in [router-data](https://github.gds/gds/router-data) for the artefact slug. This should be a `prefix` route, so all parts of the Smart Answer URL are matched and preserved. ([This is a good example](https://github.gds/gds/router-data/blob/master/data/slug-changes.csv#L623))
1415

1516
## Flow file naming convention
1617

doc/continuous-integration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Main
44

5-
The [govuk_smart_answers CI instance](https://ci-new.alphagov.co.uk/job/govuk_smart_answers/) is triggered by new commits on the `master` branch of the [GitHub repo](https://github.com/alphagov/smart-answers). It runs the [`jenkins.sh`](https://github.com/alphagov/smart-answers/blob/master/jenkins.sh) script with the `RUN_REGRESSION_TESTS` not set. This script does the following:
5+
The [govuk_smart_answers CI instance](https://ci.dev.publishing.service.gov.uk/job/govuk_smart_answers/) is triggered by new commits on the `master` branch of the [GitHub repo](https://github.com/alphagov/smart-answers). It runs the [`jenkins.sh`](https://github.com/alphagov/smart-answers/blob/master/jenkins.sh) script with the `RUN_REGRESSION_TESTS` not set. This script does the following:
66

77
* Attempts to merge the current branch (`master`) into `master` - this should always succeed and is effectively a no-op
88
* Checks out the latest [govuk-content-schemas](https://github.com/alphagov/govuk-content-schemas) which are used in a few of the tests
@@ -15,7 +15,7 @@ If any of these steps fails, the build fails-fast.
1515

1616
## Branches
1717

18-
The [govuk_smartanswers_branches CI instance](https://ci-new.alphagov.co.uk/job/govuk_smartanswers_branches/) is triggered by new commits on other branches of the [GitHub repo](https://github.com/alphagov/smart-answers). It runs the [`jenkins_branches.sh`](https://github.com/alphagov/smart-answers/blob/master/jenkins_branches.sh) script with the `RUN_REGRESSION_TESTS` not set.
18+
The [govuk_smartanswers_branches CI instance](https://ci.dev.publishing.service.gov.uk/job/govuk_smartanswers_branches/) is triggered by new commits on other branches of the [GitHub repo](https://github.com/alphagov/smart-answers). It runs the [`jenkins_branches.sh`](https://github.com/alphagov/smart-answers/blob/master/jenkins_branches.sh) script with the `RUN_REGRESSION_TESTS` not set.
1919

2020
This script calls the [`jenkins.sh`](https://github.com/alphagov/smart-answers/blob/master/jenkins.sh) script wrapping it in code which sends notifications to GitHub, so that the build status is displayed on [pull request pages](https://github.com/alphagov/smart-answers/pulls).
2121

@@ -25,7 +25,7 @@ If the merge succeeds then the script continues as for the main CI instance.
2525

2626
## Regression
2727

28-
The [govuk_smart_answers_regressions CI instance](https://ci-new.alphagov.co.uk/job/govuk_smart_answers_regressions/) is triggered periodically (currently every 2 hours). It runs the [`jenkins.sh`](https://github.com/alphagov/smart-answers/blob/master/jenkins.sh) script with the `RUN_REGRESSION_TESTS` set. This script does the following:
28+
The [govuk_smart_answers_regressions CI instance](https://ci.dev.publishing.service.gov.uk/job/govuk_smart_answers_regressions/) is triggered periodically (currently every 2 hours). It runs the [`jenkins.sh`](https://github.com/alphagov/smart-answers/blob/master/jenkins.sh) script with the `RUN_REGRESSION_TESTS` set. This script does the following:
2929

3030
* Checks out the lastest [govuk-content-schemas](https://github.com/alphagov/govuk-content-schemas) which are used in a few of the tests
3131
* Installs the bundled gems

doc/deploying.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
## Integration
44

5-
This happens automatically as a post build action when the govuk_smart_answers build passes on CI.
5+
This happens automatically as a post build action when the [govuk_smart_answers](https://ci.dev.publishing.service.gov.uk/job/govuk_smart_answers/) build passes on CI.
66

77
### Manually
88

99
If you have sufficient permissions, you can use the [Integration Deploy App](https://deploy.integration.publishing.service.gov.uk/job/Deploy_App/). Click the "Build with Parameters" link and enter "release" as the "TAG".
1010

11-
If you do not have sufficient permissions, you can either kick the main CI build in Jenkins or commit & push something to the `master` branch.
11+
If you do not have sufficient permissions, you can either kick the [main CI build](continuous-integration.md#main) in Jenkins or commit & push something to the `master` branch.
1212

1313
## Production
1414

0 commit comments

Comments
 (0)