Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
CI tools
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
EOLE
Infra
CI tools
Commits
b6d5bc56
Commit
b6d5bc56
authored
2 years ago
by
Daniel Dehennin
Browse files
Options
Downloads
Patches
Plain Diff
docs(getting-started): update `semantic-release` configuration steps
parent
2ba784d8
Branches
25-add-synchro-and-build-template
No related tags found
3 merge requests
!61
Publish new release
,
!60
Prepare new release
,
!55
Resolve "All semantic-release configuration should be in a single file"
Pipeline
#13480
passed
2 years ago
Stage: lint
Stage: build
Stage: release
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/GETTING-STARTED.md
+9
-13
9 additions, 13 deletions
docs/GETTING-STARTED.md
with
9 additions
and
13 deletions
docs/GETTING-STARTED.md
+
9
−
13
View file @
b6d5bc56
...
...
@@ -332,7 +332,7 @@ you need mostly 4 steps:
new-release
:
{
extends
:
'
.semantic-release:stable'
}
# Create the prereleases versions on `$TESTING_BRANCH`
# update `release
.config
.js` variable `betaBranch`
# update `
.
release
rc
.js` variable `betaBranch`
testing-prerelease
:
{
extends
:
'
.semantic-release:testing'
}
# Avoid regression by merging all pre-release fixes to `$DEV_BRANCH`
...
...
@@ -399,12 +399,10 @@ you need mostly 4 steps:
</details>
2.
configure
[
`commitlint`
](
#validate-commit-messages
)
with the
[
`.commitlintrc.yaml`
](
.commitlintrc.yaml
)
3.
configure
[
`semantic-release`
](
#generate-release-with-semantic-version-scheme
)
1.
the general configuration
[
`release.config.js`
](
release.config.js
)
(
note
that the
`branches`
variable must match your
`$STABLE_BRANCH`
)
2.
the version bump rules in
[
`release-rules.js`
](
release-rules.js
)
3.
add a
`Dockerfile`
in the root directory of your sources
3.
configure
[
`semantic-release`
](
#generate-release-with-semantic-version-scheme
)
in
[
`.releaserc.js`
](
.releaserc.js
)
(
note
that the
`branches`
variable must match your
`$STABLE_BRANCH`
)
4.
add a
`Dockerfile`
in the root directory of your sources
### Step by step setup
...
...
@@ -511,9 +509,7 @@ you need to:
your
`.gitlab-ci.yml`
4.
define the
`new-release`
job extending
[
`.semantic-release:stable`
](
templates/Semantic-release.yaml#L17-L81
)
5.
define the
`testing-prerelease`
job extending
[
`.semantic-release:testing`
](
templates/Semantic-release.yaml#L84-L144
)
6.
configure
`semantic-release`
:
1.
[
`release.config.js`
](
release.config.js
)
2.
[
`release-rules.js`
](
release-rules.js
)
6.
configure
`semantic-release`
in
[
`.releaserc.js`
](
.releaserc.js
)
```
diff
--- .gitlab-ci.yml.orig
...
...
@@ -545,7 +541,7 @@ you need to:
+new-release: {extends: '.semantic-release:stable'}
+
+# Create the prereleases versions on `$TESTING_BRANCH`
+# update `release
.config
.js` variable `betaBranch`
+# update `
.
release
rc
.js` variable `betaBranch`
+testing-prerelease: {extends: '.semantic-release:testing'}
...
```
...
...
@@ -679,7 +675,7 @@ To be used, you need to:
new-release: {extends: '.semantic-release:stable'}
@@ -68,4 +68,61 @@
# Create the prereleases versions on `$TESTING_BRANCH`
# update `release
.config
.js` variable `betaBranch`
# update `
.
release
rc
.js` variable `betaBranch`
testing-prerelease: {extends: '.semantic-release:testing}
+
+## tag contribution branches with a more stable name than `git-${CI_COMMIT_SHORT_SHA}`
...
...
@@ -773,7 +769,7 @@ To do so, you need to:
# Create the release versions on `$STABLEE_BRANCH`
new-release: {extends: '.semantic-release:stable'}
@@ -69,6 +70,9 @@
# update `release
.config
.js` variable `betaBranch`
# update `
.
release
rc
.js` variable `betaBranch`
testing-prerelease: {extends: '.semantic-release:testing}
+# Avoid regression by merging all pre-release fixes to `$DEV_BRANCH`
...
...
This diff is collapsed.
Click to expand it.
Ghost User
@ghost
mentioned in commit
fe870d2d
·
2 years ago
mentioned in commit
fe870d2d
mentioned in commit fe870d2d43d9c106dd93fdba18187735a5d6f327
Toggle commit list
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment