semantic-release / semantic-release/gitlab
Documentation improvements.
Open
Nobody has claimed this yet.
docs
- Dominant language
- JavaScript
- Stars
- 344
- Forks
- 89
- Avg merge
- 16h 11m
- Merged PRs (30d)
- 4
Description
I think it's a better to make these example uniform, it's really confusing.
semantic-release/gitlab (this project)
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
["@semantic-release/gitlab", {
"gitlabUrl": "https://custom.gitlab.com",
"assets": [
{"path": "dist/asset.min.css", "label": "CSS distribution"},
{"path": "dist/asset.min.js", "label": "JS distribution"}
]
}],
]
}
- It's not clear from the above how to publish an angular project, which builds into
disthand has many "assets".npm packjust needs to be told to thedist/directory that contains thepackage.json, for examplenpm pack dist/my-workspace/my-lib. How do we package an angular project with Semantic-Release gitlab like above? - You post a
gitlabUrlin there. It's not clear why I would ever want that. That can be supported by thepackage.json. Why would I want it here. For simplicity I would remove it.
GitLab wiki,
The following is from the GitLab wiki,
{
"branches": ["master"],
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"@semantic-release/gitlab",
"@semantic-release/npm",
[
"@semantic-release/git",
{
"assets": ["package.json"],
"message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
}
]
]
}
- Note this has
branchesThat seems to be required. If it is this project should probably also contain it.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the two configuration examples in the issue and compare them with the linked GitLab wiki example. Clarify how an Angular project with a dist package is packaged, explain or remove the gitlabUrl example, and establish whether branches belongs in the project example. Done means the documentation presents uniform, unambiguous configurations and answers these questions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, javascript
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100