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

[FEATURE] implement a versioning and changelog system #75

Open
FrancescoXX opened this issue Jul 14, 2024 · 6 comments
Open

[FEATURE] implement a versioning and changelog system #75

FrancescoXX opened this issue Jul 14, 2024 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@FrancescoXX
Copy link
Owner

you can just explain the process, based on your experience with other projects.

for things only admins can do on this repo, just tag me @FrancescoXX

@FrancescoXX FrancescoXX added the documentation Improvements or additions to documentation label Jul 14, 2024
@Pradumnasaraf
Copy link

Hey, @FrancescoXX it will be really simple to implement.

Steps:

  • Create a file called releases.yml (Of course, you can name it anything, but this is more understandable) inside the workflows folder, which is inside your .github folder located in the root. So, the path will look like this: .github/workflows/releases.yml

  • Copy the below configuration. The workflow needs write permission to create tags and releases, so we need to give write permission.

name: Releases and Changelog
on:
  push:
    branches:
      - main

jobs:
  changelog:
    runs-on: ubuntu-latest

    permissions:
      actions: write
      contents: write

    steps:
      - uses: actions/checkout@v4

      - name: Conventional Changelog Action
        id: changelog
        uses: TriPSs/conventional-changelog-action@v5
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          version-file: './package.json,./package-lock.json'

      - name: Create Release
        if: steps.changelog.outputs.skipped == 'false'
        uses: ncipollo/release-action@v1
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          tag: ${{ steps.changelog.outputs.tag }}
          name: ${{ steps.changelog.outputs.tag }}
          body: ${{ steps.changelog.outputs.clean_changelog }}

Let me know if you need any help :)

Also, change the documentation Improvements or additions to documentation issue label to something to CI/automation or something different.

@FrancescoXX
Copy link
Owner Author

I can literally do this in a minute, but let's wat for a contributor and see if they want a green square :)

@FrancescoXX FrancescoXX added the good first issue Good for newcomers label Jul 15, 2024
@SD191100
Copy link

SD191100 commented Aug 4, 2024

hello @FrancescoXX i am a beginner web dev and i want to contribute to this issue, can i do it?

@akkota
Copy link

akkota commented Aug 4, 2024

@FrancescoXX Hello, would love to work on this!

@prathmesh0125
Copy link
Contributor

@FrancescoXX please assign this task to me i will work on this

@prathmesh0125
Copy link
Contributor

@FrancescoXX i did this please check

@FrancescoXX
Copy link
Owner Author

@akkota I am checking this just now, please check another issue, thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants