JSCutlery/semver integration

[dianjuar]

Let's discuss about integration, know issues, patches needed, approaches, experiences, current successful histories and anything related about the simbiosis between ngx-deploy-npm and JSCutlery/semver

[spaceribs]

The RFC at jscutlery/semver#317 continues to use the pattern of pre/post tasks referenced in the configuration, which effectively solves most of the issues I've run into. The only issue I see with this pattern is that now we have one very big task which encapsulates semver bumping, building, packaging and delivering.

[edbzn]

The RFC is about scheduling a target post-release and resolving the options for it, releasing and publishing will still be two decoupled tasks.

[edbzn]

Here is the related discussion: jscutlery/semver#167, we want to schedule post-release targets to be able to do things like:

• publish to npm (using ngx-deploy-npm)
• publish GitHub release
• ...

If you think about a better way to trigger post-release targets, I would listen to you your suggestions.

[edbzn]

Hi, so it's not a RFC anymore, postTargets are merged in @jscutlery/semver. Here is an example of using it:

{
  "targets": {
    "version": {
      "executor": "@jscutlery/semver:version",
      "options": {
        "postTargets": ["my-project:github"]
      }
    },
    "github": {
      "executor": "@jscutlery/semver:github",
      "options": {
        "tag": "${tag}",
        "notesFile": "libs/my-project/CHANGELOG.md"
      }
    }
  }
}

I would like to reference ngx-deploy-npm in the documentation and give a configuration example. @dianjuar Could you help me to do so? The final objective is being able to deploy to npm directly in the CI.

[edbzn]

Ok I will dig into this, first findings. I'm sure it will be fun. 😄

[dianjuar]

Now that #83 and #84 are merged, is possible to use semver's postTargets feature.

PR's are welcome

[dianjuar]

Issue to address the integration #85

[dianjuar]

Feels pretty cool to solve this integration issue with your own projects 😄

[dianjuar]

@edbzn I made my test with our plugins, and everything works as expected. I don't have a new version to deploy yet, so I haven't thoroughly test it.

The final configuration would look like this:

"deploy": {
  "executor": "ngx-deploy-npm:deploy",
  "options": {
    "access": "public"
  }
},
"version": {
  "executor": "@jscutlery/semver:version",
  "options": {
    "postTargets": ["my-project:deploy"],
    "versionTagPrefix": "v",
    "baseBranch": "master"
  }
}

Or can take a look at our workspace.json for a real implementation

[dianjuar]

@edbzn you mentioned on #70 the following

I can already see conflicting things between ngx-deploy-npm and @jscutlery/semver, this option --package-version for example can conflict/override what semver did just before.

I can't see the problem there, let me explain.
That option is completely optional and was designed to replicate the same behavior that Angular Does with their packages, you can see that they have a placeholder on the version number and another process is going to generate the version number. If you build your lib that place holder is going to end up on the final package.json, with that option you can just overwrite that place holder with the number you want.

There is something that I'm not seeing?

[dianjuar]

Remember that --package-version is optional on ngx-deploy-npm, by default is going to publish the version specified on the package.json.

[dianjuar]

Please let me know if there is something that I'm not understanding.

[spaceribs]

I'm using --package-version, and here's how/why:

When users create new pull requests on my system, I use this option to publish a canary of the affected projects. For that action, I do not want to create a commit, and the version number gets overridden to something like 0.0.0-pr-101-82a57c4 and tagged to be downloaded as @spaceribs/plopdown-file@pr-101. To be clear, I'm not using semver at all for this.

[edbzn]

Interesting @spaceribs, it's another topic but you caught my attention, can you show me the code where you do that if it's not private?

[spaceribs]

unfortunately it is in a private repo, but the command I run in the pull request after the build job looks like this:

nx affected --target="publish" --tag="pr-${CIRCLE_PR_NUMBER}" --package-version="0.0.0-pr-${CIRCLE_PR_NUMBER}-${CIRCLE_BUILD_NUM}"

[dianjuar]

@edbzn Now that this tool is fully migrated to use NxDevkit, you can use it to deploy Semver.

As Semver uses Semver to generate Semver's changelogs, you can test the integration with your project.
I'm doing the same with this project now that here we are using Semver (#83)

I will document the process right here 👇

[edbzn]

Hey, we made it yesterday for @jscutlery/devkit, and it's fully working in the CI.

[dianjuar]

You can share your experience here on #81 🎉

[dianjuar]

I did the integration in this plugin as well. Waiting to have a new version to publish to fully test it out

[dianjuar]

@edbzn I had to update Semver to the last version to trigger postTargets properly, see #93

[dianjuar]

@edbzn, do you have anything more to discuss, clarify or test about the integration?

For my part, I'm more than satisfied 😁.
Everything is running as expected. I'm using the integration here in the project, and your plugin is also using it, which does two big projects implementing the integration successfully.

All the tasks related to the integration are complete, and we have already documented the process.

I want to mark this discussion as complete unless you have something more to bring to the table. (I don't know how to complete it 😅)

[edbzn]

@dianjuar For my part, it's working like a charm, I think @jscutlery/semver and ngx-depy-npm work seamlessly together. One thing I plan to do soon is canary releases as your package allows it.

I think you cannot mark the discussion as complete as it's not a Q/A.

[dianjuar]

@edbzn you're right about the discussion.

The only thing that I can do is lock the conversation to "complete it".

@edbzn @spaceribs Thank you for everything.
It was fun ❤️