Skip to content

Commit

Permalink
ci: bump magic_combo to 0.2 (#4)
Browse files Browse the repository at this point in the history
* ci: use magic_combo 0.2

* chore(changelog): add changelog entry for the magic_combo bump

* ci: update allowed scopes

* ci: simplify versions setup

* ci: trigger build on pull_request

* ci: use magic_combo as action

* chore: update contributing

* chore(readme): fix readme lint
  • Loading branch information
florianvazelle authored Oct 20, 2023
1 parent 6b7bf33 commit e840928
Show file tree
Hide file tree
Showing 9 changed files with 56 additions and 139 deletions.
5 changes: 5 additions & 0 deletions .combo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
godot:
version: '4.1.2'
game:
name: Greeter
version: '0.1.1'
19 changes: 7 additions & 12 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ on:
push:
branches: [4.x]
tags: ['*']
pull_request:
branches: [4.x]
workflow_dispatch:

env:
Expand Down Expand Up @@ -34,20 +36,13 @@ jobs:
steps:
- uses: actions/checkout@v4

- name: Setup Versions Vars
run: |
echo "game_version=$(cat .version)" >> $GITHUB_ENV
echo "godot_version=$(cat .godot_version)" >> $GITHUB_ENV
- name: Set up Python
uses: actions/setup-python@v4
- uses: MechanicalFlower/magic_combo@main
with:
python-version: '3.10'
command: script.add-config-to-github-env

- name: Bump Version
run: |
pip install magic-combo==0.1.1
bump_version --version-file .version --cfg-file export_presets.cfg
- uses: MechanicalFlower/magic_combo@main
with:
command: script.bump-version

- name: Ensure version is equal to tag
if: startsWith(github.ref, 'refs/tags/')
Expand Down
5 changes: 3 additions & 2 deletions .github/workflows/lint_pr_title.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
scopes: |
playbook
addons
assets
scripts
tasks
scenes
dependabot
workflows
readme
Expand Down
1 change: 0 additions & 1 deletion .godot_version

This file was deleted.

1 change: 0 additions & 1 deletion .version

This file was deleted.

1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Fixed
### Security
### Dependencies
- Bump `magic_combo` from 0.1 to 0.2 ([#4](https:/github.com/MechanicalFlower/godot-template/pull/4))

[Unreleased]: https://github.com/MechanicalFlower/godot-template/compare/0.1.0...HEAD
64 changes: 34 additions & 30 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Contributing

We welcome contributions to our open source Godot game project! There are many ways you can help, including reporting bugs, improving documentation, and contributing code.
We welcome contributions to our open source Godot
game project! There are many ways you can help,
including reporting bugs, improving documentation,
and contributing code.

## Code of Conduct

We value the participation of every member of our community and want to ensure that everyone has an enjoyable and fulfilling experience. As such, we have adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as our code of conduct. By participating in this project, you agree to abide by its terms.

## Prerequisites

Before you start, you will need the following:

- A GitHub account
- A copy of the Godot game engine installed on your computer
- Familiarity with Git and GitHub
We value the participation of every member of our
community and want to ensure that everyone
has an enjoyable and fulfilling experience. As
such, we have adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as
our code of conduct. By participating in this
project, you agree to abide by its terms.

## Contributing Code

Expand All @@ -25,34 +25,38 @@ To contribute code to the project, follow these steps:
5. Push your changes to your forked repository on GitHub.
6. Create a pull request from your forked repository to the original repository.

Please note that all code contributions should pass the continuous integration (CI) checks that are set up for the project. These checks ensure that the code is well-formatted and that tests are passing.

## Pre-commit Requirements

To ensure that your code passes the CI checks, you should run the following pre-commit checks before committing and pushing your changes:

- Run the code formatter to ensure that your code is properly formatted according to the project's style guidelines.
- Run the test suite to ensure that all tests are passing.

You can set up pre-commit hooks to automatically run these checks before you commit your changes. To do this, you will need to install the following tools:

- The `pre-commit` Python package: This package contains a set of tools for running checks on your code before committing it. You can install it using `pip install pre-commit`.
- The `godot-gdscript-toolkit`: This toolkit contains a set of tools for formatting and linting GDScript code. You can install it using `pip install 'gdtoolkit==4.*'`.

Then, run `pre-commit install` to set up the hooks.
Please note that all code contributions should
pass the continuous integration (CI) checks
that are set up for the project. These checks
ensure that the code is well-formatted and
that tests are passing.

Alternatively, you can run `pre-commit run --all-files` to manually run all the checks on your code before committing. This can save you time and ensure that your code is ready to be merged into the main repository.

## Reporting Bugs

If you find a bug in the project, please report it by creating an issue in the repository's issue tracker. Be sure to include as much information as possible, including the steps to reproduce the bug and any relevant error messages.
If you find a bug in the project, please report
it by creating an issue in the repository's issue
tracker. Be sure to include as much information
as possible, including the steps to reproduce
the bug and any relevant error messages.

## Improving Documentation

If you would like to improve the documentation for the project, you can do so by submitting a pull request with your changes. Please follow the same process as for contributing code, and make sure that your changes are properly formatted and well-written.
If you would like to improve the documentation
for the project, you can do so by submitting a
pull request with your changes. Please follow
the same process as for contributing code, and
make sure that your changes are properly formatted
and well-written.

## Questions and Feedback

If you have any questions or feedback about the project, don't hesitate to reach out! You can create an issue in the repository's issue tracker, or contact us directly through our website or social media channels.
If you have any questions or feedback about the
project, don't hesitate to reach out! You can
create an issue in the repository's issue tracker,
or contact us directly through our website or
social media channels.

Thank you for considering contributing to our open source Godot game project! We appreciate your help and look forward to working with you.
Thank you for considering contributing to our
open source Godot game project! We appreciate
your help and look forward to working with you.
92 changes: 0 additions & 92 deletions Makefile

This file was deleted.

7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@

# 📝 Greeter

![Godot Badge](https://img.shields.io/badge/godot-4.0-blue?logo=Godot-Engine&logoColor=white) ![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white) ![license](https://img.shields.io/badge/license-MIT-green?logo=open-source-initiative&logoColor=white) ![reuse](./.reuse/REUSE-compliant.svg)
![Godot Badge](https://img.shields.io/badge/godot-4.1-blue?logo=Godot-Engine&logoColor=white)
![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)
![license](https://img.shields.io/badge/license-MIT-green?logo=open-source-initiative&logoColor=white)
![reuse](./.reuse/REUSE-compliant.svg)

A template to create new [Godot Engine](https://godotengine.org/) project.

Expand Down Expand Up @@ -31,6 +34,8 @@ Feel free to replace the License with one suited for your project.

## Contributing

![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)

We welcome community contributions to this project.

Please read our [Contributor Guide](CONTRIBUTING.md) for more information on how to get started.

0 comments on commit e840928

Please sign in to comment.