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

Improve Netlify deployment message #275

Open
tbouffard opened this issue Dec 8, 2021 · 0 comments
Open

Improve Netlify deployment message #275

tbouffard opened this issue Dec 8, 2021 · 0 comments
Labels
CI ⚙️ enhancement New feature or request

Comments

@tbouffard
Copy link
Member

tbouffard commented Dec 8, 2021

Currently, when the deployment is triggered by a doc-site change, we only display the commit sha from the bonita-documentation-site repository.

image

We could add a prefix like 'site update' and use a short commit sha (as also suggested for #228) and always remove the Deploy prefix which is implicit (this includes deployment triggered by documentation content change).
For instance site update 1d69bc0

We should do the same when triggered manually

  • current: Deploy ${{github.sha}} from manual request
  • proposal: site request 1d69bc0

Proposal Summary

The message form will be <source> <type> <short_sha>
For instance

Resources for short sha

About the message construction

Currently, the message is built by using several steps that are run depending of the availability of some values in the input event and they are written in bash.
The maintenance is not easy and this will be harder with the requirements described in this issue.
We could switch the implementation to JavaScript that allows easy string transforms.
This could be done by using https://github.com/actions/github-script or setting the step shell to shell: node {0}

steps:
  - name: Use JavaScript to defined the step content
    shell: node {0}
    run: |
      // my super JavaScript code here
@tbouffard tbouffard changed the title Improve Netlify deployment message when it is triggered by a doc-site change Improve Netlify deployment message Dec 8, 2021
@tbouffard tbouffard added the enhancement New feature or request label Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI ⚙️ enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant