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.

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

[IMP] config: improve the versionning of gh releases and npm publications #2136

Closed
wants to merge 2 commits into from

Conversation

rrahir
Copy link
Collaborator

@rrahir rrahir commented Mar 1, 2023

Description:

description of this task, what is implemented and why it is implemented that way.

Odoo task ID : TASK_ID

review checklist

  • feature is organized in plugin, or UI components
  • support of duplicate sheet (deep copy)
  • in model/core: ranges are Range object, and can be adapted (adaptRanges)
  • in model/UI: ranges are strings (to show the user)
  • undo-able commands (uses this.history.update)
  • multiuser-able commands (has inverse commands and transformations where needed)
  • new/updated/removed commands are documented
  • exportable in excel
  • translations (_lt("qmsdf %s", abc))
  • unit tested
  • clean commented code
  • track breaking changes
  • doc is rebuild (npm run doc)
  • status is correct in Odoo

We currently do not specify any tag when publishing on NPM, which
defaults to `latest`. Since we don't want old versions to be tagged as
such, we add a tag in `package.json` to control which version has the
flag `latest`.

Note that according to the NPM documentation[1], the tag cannot match a
semVer range [2][3] which is why we use a special tag that only
indentifies the major version of the package.

[1] https://docs.npmjs.com/cli/v9/commands/npm-dist-tag#caveats
[2] https://semver.org/
[3] https://www.telerik.com/blogs/the-mystical-magical-semver-ranges-used-by-npm-bower
When creating a GH release, the default option is to set it as the
latest one. By disabling this option, we rely on the semantic
version of the release tag to define the latest release.

We can also set the prerelease option to flag potentially unstable
releases.

References:
[1] https://github.blog/changelog/2022-10-21-explicitly-set-the-latest-release/
[2] https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28
[3] https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository
@robodoo
Copy link
Collaborator

robodoo commented Mar 1, 2023

@rrahir
Copy link
Collaborator Author

rrahir commented Mar 1, 2023

@fw-bot ignore

Copy link
Collaborator

@pro-odoo pro-odoo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

robodoo rebase-ff r+

@fw-bot
Copy link
Collaborator

fw-bot commented Mar 1, 2023

Forward-port disabled.

@robodoo
Copy link
Collaborator

robodoo commented Mar 1, 2023

Merge method set to rebase and fast-forward.

robodoo pushed a commit that referenced this pull request Mar 1, 2023
We currently do not specify any tag when publishing on NPM, which
defaults to `latest`. Since we don't want old versions to be tagged as
such, we add a tag in `package.json` to control which version has the
flag `latest`.

Note that according to the NPM documentation[1], the tag cannot match a
semVer range [2][3] which is why we use a special tag that only
indentifies the major version of the package.

[1] https://docs.npmjs.com/cli/v9/commands/npm-dist-tag#caveats
[2] https://semver.org/
[3] https://www.telerik.com/blogs/the-mystical-magical-semver-ranges-used-by-npm-bower

Part-of: #2136
robodoo pushed a commit that referenced this pull request Mar 1, 2023
When creating a GH release, the default option is to set it as the
latest one. By disabling this option, we rely on the semantic
version of the release tag to define the latest release.

We can also set the prerelease option to flag potentially unstable
releases.

References:
[1] https://github.blog/changelog/2022-10-21-explicitly-set-the-latest-release/
[2] https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28
[3] https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository

closes #2136

Signed-off-by: Pierre Rousseau (pro) <pro@odoo.com>
@robodoo robodoo temporarily deployed to merge March 1, 2023 13:05 Inactive
@robodoo robodoo closed this Mar 1, 2023
@fw-bot fw-bot deleted the 15.0-npm-tag-rar branch March 15, 2023 13:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants