From 5c7fcdae062169316983eb5cf6b44d8f1572365f Mon Sep 17 00:00:00 2001 From: P0nk Date: Sun, 16 Oct 2022 08:34:45 +0200 Subject: [PATCH 1/4] Add action to automatically tag commits Using this action: https://github.com/marketplace/actions/github-tag-bump The idea is that the repo will be versioned in SemVer format, such as "v0.5.3". When a PR is merged, a new version will automatically be added. The new version is generated based on the latest tag, and the part that is bumped is dictated by the merge commit message, either #major, #minor (default) or #patch. This way I (the repo owner) has control over versioning, and other contributors don't have to bother with anything. --- .github/workflows/bump-version.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/workflows/bump-version.yml diff --git a/.github/workflows/bump-version.yml b/.github/workflows/bump-version.yml new file mode 100644 index 0000000000..4cd2ae0292 --- /dev/null +++ b/.github/workflows/bump-version.yml @@ -0,0 +1,23 @@ +name: Bump version +on: + pull_request: + #types: + # - closed + branches: + - master + +jobs: + build: + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.event.pull_request.head.sha }} + fetch-depth: '0' + + - name: Bump version and push tag + uses: anothrNick/github-tag-action@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + WITH_V: true + DRY_RUN: true \ No newline at end of file From e12d853499f066bbb91974387ba7ca79f3897f19 Mon Sep 17 00:00:00 2001 From: P0nk Date: Sun, 16 Oct 2022 08:48:32 +0200 Subject: [PATCH 2/4] Update build workflow - new name and updated dependencies --- .github/workflows/bump-version.yml | 2 ++ .../workflows/{pr-pipeline.yml => run-build.yml} | 13 +++++-------- 2 files changed, 7 insertions(+), 8 deletions(-) rename .github/workflows/{pr-pipeline.yml => run-build.yml} (57%) diff --git a/.github/workflows/bump-version.yml b/.github/workflows/bump-version.yml index 4cd2ae0292..f2f8a1d8c6 100644 --- a/.github/workflows/bump-version.yml +++ b/.github/workflows/bump-version.yml @@ -1,3 +1,5 @@ +# This workflow will tag the merge commit when merging a PR into the master branch. + name: Bump version on: pull_request: diff --git a/.github/workflows/pr-pipeline.yml b/.github/workflows/run-build.yml similarity index 57% rename from .github/workflows/pr-pipeline.yml rename to .github/workflows/run-build.yml index a44c2607ac..3d8a42ac71 100644 --- a/.github/workflows/pr-pipeline.yml +++ b/.github/workflows/run-build.yml @@ -1,21 +1,18 @@ # This workflow will build a Java project with Maven -# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven - -name: PR-maven-package +name: Run build on: pull_request: - branches: [ master ] + branches: + - master jobs: build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Set up JDK 17 - uses: actions/setup-java@v2 + uses: actions/setup-java@v3 with: java-version: '17' distribution: 'temurin' From 41cf8b4485225dc6bc8ed8b5af17f8a2486e01f9 Mon Sep 17 00:00:00 2001 From: P0nk Date: Sun, 16 Oct 2022 09:45:48 +0200 Subject: [PATCH 3/4] Update README - add "Working with GitHub", "Versioning" --- README.md | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d3b21a93ed..870e18d3a7 100644 --- a/README.md +++ b/README.md @@ -17,16 +17,39 @@ without knowing what you're doing is not recommended. ## Development information -### Status (updated 2022-08-02) +### Status (updated 2022-10-16) -Development is currently **sporadic**. Bugs may be fixed, and pull requests reviewed, but don't expect anything groundbreaking. +Development is currently **sporadic**. + +My time is very limited nowadays, but I try to keep up with the submitted pull requests. I may submit some stuff of my own, once in a while. ### Ways to contribute -* Submit a Pull Request (fork -> commit -> PR) -* Submit a bug report (add a new issue on GitHub, or post in `bug-report` on Discord) +* Submit a Pull Request (fork -> commit -> PR). If you don't know where to start, have a look at the issues on GitHub. +* Report a bug (preferably as an Issue on GitHub, as reports on Discord may be forgotten or lost) * Spread the word about Cosmic +### Working with GitHub + +Anyone with a GitHub account can contribute by making some changes in a branch and opening up a PR. + +All activity on the GitHub repo (opening PR, commenting, creating issue, etc.) is automatically pushed (via webhook) to a public Discord channel for visibility. + +Issues is the main place where bugs, issues or general improvements are tracked. Feel free to submit a new issue, but please keep it in English. By providing a good description, you increase the chance of a bug being fixed. + +Tasks (past, present and future) are kept in the Cosmic project, which you get to via the "Projects" tab. This gives you an idea of where the project is moving. + +### Versioning + +The project follows the [SemVer](https://semver.org/) versioning scheme using git tags. +As a pull request gets merged, a new version is automatically created. + +Bug fixes result in bumped patch version: 1.2.__3__ -> 1.2.__4__ + +General improvements result in bumped minor version: 1.__2__.3 -> 1.__3__.3 + +Major changes result in bumped major version: __1__.2.3 -> __2__.2.3 + ### Cosmic - GitHub: https://github.com/P0nk/Cosmic @@ -59,6 +82,7 @@ Development is currently **sporadic**. Bugs ma * **Client files and general tools** * Link: https://drive.google.com/drive/folders/1hgnb92MGL6xqEp9szEMBh0K9pSJcJ6IT?usp=sharing + * This is Ponk's own Google Drive, similar to how Ronan provides files for HeavenMS. ### MapleStory client From 584fccec92ce70efababeaf4b866accd92588eec Mon Sep 17 00:00:00 2001 From: P0nk Date: Sun, 16 Oct 2022 10:04:35 +0200 Subject: [PATCH 4/4] Activate bump-version action --- .github/workflows/bump-version.yml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/workflows/bump-version.yml b/.github/workflows/bump-version.yml index f2f8a1d8c6..4ae1b4a5ed 100644 --- a/.github/workflows/bump-version.yml +++ b/.github/workflows/bump-version.yml @@ -3,8 +3,8 @@ name: Bump version on: pull_request: - #types: - # - closed + types: + - closed branches: - master @@ -21,5 +21,4 @@ jobs: uses: anothrNick/github-tag-action@v1 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - WITH_V: true - DRY_RUN: true \ No newline at end of file + WITH_V: true \ No newline at end of file