Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation improvements. #258

Open
EvanCarroll opened this issue Jul 22, 2021 · 2 comments
Open

Documentation improvements. #258

EvanCarroll opened this issue Jul 22, 2021 · 2 comments
Labels
docs

Comments

@EvanCarroll
Copy link

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"}
      ]
    }],
  ]
}
  1. It's not clear from the above how to publish an angular project, which builds into dist hand has many "assets". npm pack just needs to be told to the dist/ directory that contains the package.json, for example npm pack dist/my-workspace/my-lib. How do we package an angular project with Semantic-Release gitlab like above?
  2. You post a gitlabUrl in there. It's not clear why I would ever want that. That can be supported by the package.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}"
      }
    ]
  ]
}
  1. Note this has branches That seems to be required. If it is this project should probably also contain it.
@EvanCarroll EvanCarroll changed the title Documentation fix. Documentation improvements. Jul 22, 2021
@triwats
Copy link

triwats commented Sep 20, 2021

This seems really sane to me and should be approved

JonasSchubert added a commit to JonasSchubert/gitlab that referenced this issue Apr 16, 2022
@JonasSchubert
docs(usage): add branches to provide working example semantic-release…
d4ee41e 
…#258
@JonasSchubert JonasSchubert mentioned this issue Apr 16, 2022
Merged
@JonasSchubert
Copy link
Contributor

Hi. I created a small PR #366 to start working on this. Feel free to jump on and work on this. I just added the missing configuration for branches.

Regarding your remarks:

  1. In your angular example: Do you want to create a NPM package or a zipped dist folder? If you want to create a NPM package hosted in the package registry, I think the documentation for the NPM plugin is more relevant.
  2. I think the gitlabUrl is there to showcase some possibilities which will be explained further down. I agree that most people will not set this property because they will use the CI/CD. Here we use the provided env vars. But if one wants to use the CLI and has a private instance it might be useful to know.

These are just my thoughts. Feel free to add and change the mentioned PR to optimize the documentation 😉

fgreinacher added a commit that referenced this issue Apr 26, 2022
@JonasSchubert @fgreinacher
docs(usage): add branches to provide working example #258 (#366)
b4b8e71 
Co-authored-by: Florian Greinacher <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@EvanCarroll @fgreinacher @triwats @JonasSchubert