diff --git a/.github/actions/gradle/action.yml b/.github/actions/gradle/action.yml deleted file mode 100644 index df84718..0000000 --- a/.github/actions/gradle/action.yml +++ /dev/null @@ -1,36 +0,0 @@ - -# -# This action *WILL REQUIRE* to do the checkout before (as it is used from the same repository). -# -name: Gradle -description: Run a Gradle build executing the supplied tasks. - -inputs: - java: - description: Java version used to run Gradle. - required: true - default: "17" - - java_distribution: - description: Java distribution used to run Gradle. - required: true - default: temurin - - tasks: - description: Gradle tasks to execute. - required: true - default: build - -runs: - using: composite - steps: - - uses: actions/setup-java@v3 - with: - java-version: ${{ inputs.java }} - distribution: ${{ inputs.java_distribution }} - cache: gradle - - run: ./gradlew ${{ inputs.tasks }} - shell: bash - - if: failure() - run: ./gradlew --info --stacktrace ${{ inputs.tasks }} - shell: bash diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml new file mode 100644 index 0000000..88d0766 --- /dev/null +++ b/.github/workflows/nightly.yml @@ -0,0 +1,21 @@ + +name: Nightly + +on: + push: +# schedule: +# - cron: "59 23 * * *" + +jobs: + build: + strategy: + fail-fast: false + matrix: + os: [ ubuntu-latest, windows-latest, macos-latest ] + + name: Build (${{ matrix.os }}) + permissions: read-all + uses: hexagonkt/.github/.github/workflows/gradle.yml@master + with: + os: ${{ matrix.os }} + tasks: build -x jpackage diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index e649ef4..2fb02f1 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -16,9 +16,17 @@ jobs: run: | URL="https://$GITHUB_ACTOR:${{ secrets.GITHUB_TOKEN }}@github.com/$GITHUB_REPOSITORY.git" git remote set-url origin "$URL" - #git config --global user.email "juanjoaguililla@gmail.com" git config --global user.name "$GITHUB_ACTOR" - - name: Release Version - uses: ./.github/actions/gradle + - name: Set Up Java + uses: actions/setup-java@v3 with: - tasks: release + java-version: "17" + distribution: temurin + cache: gradle + - name: Release Version + run: ./gradlew release + shell: bash + - name: Release Version + if: failure() + run: ./gradlew --info --stacktrace release + shell: bash diff --git a/build.gradle.kts b/build.gradle.kts index d21db6e..c6b34cd 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -17,7 +17,7 @@ apply(from = "$gradleScripts/kotlin.gradle") apply(from = "$gradleScripts/application.gradle") group = "com.hexagonkt.tools" -version = "0.9.5" +version = "0.9.6" description = "CVs for programmers" ext { diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..7c96a3e --- /dev/null +++ b/contributing.md @@ -0,0 +1,48 @@ + +# Contributing +You can contribute code or documentation to the project. If you only intend to use the project, you +can also discuss your issues here. + +## Make a Question +You can use the repository's Discussions tab to ask questions or resolve problems. + +## Report a Bug +File an issue which comply with the [bug template] requirements. + +[bug template]: https://github.com/hexagonkt/.github/blob/master/.github/ISSUE_TEMPLATE/bug.md + +## Request a Feature +Create a new issue following the [enhancement template] rules. + +[enhancement template]: https://github.com/hexagonkt/.github/blob/master/.github/ISSUE_TEMPLATE/enhancement.md + +## Contribute an Improvement +1. You can check available tasks in the repository issues tab. Issues with the `help wanted` tag in + the `Ready` column are recommended for a first time contribution. +2. Claim an issue you want to work in with a comment, after that I can assign it to you and move it + to the `Working` column. If you want to contribute to a non tagged (or a not existing) tasks: + write a comment, and we'll discuss the scope of the feature. +3. New features should be discussed within a post in the GitHub Ideas Discussions tab of the project + before actual coding. You may do a PR directly, but you take the risk of it being not suitable + and discarded. +4. For code, file names, tags and branches use either camel case or snake case only. I.e.: avoid `-` + or `.` in file names if it is possible. +5. For a Pull Request to be accepted, follow the [pull request template] recommendations. Check the + code follows the [Kotlin Coding Conventions], except final brace position in `else`, `catch` and + `finally` (in its own line). If you use [IntelliJ] and [Editor Config] this will be checked for + you. +6. Packages must have the same folder structure as in Java (to avoid problems with tools and Java + module definition). +7. Follow the commit rules defined at the [commit guidelines]. + +[pull request template]: https://github.com/hexagonkt/.github/blob/master/pull_request_template.md +[IntelliJ]: https://www.jetbrains.com/idea +[Editor Config]: https://editorconfig.org +[Kotlin Coding Conventions]: https://kotlinlang.org/docs/reference/coding-conventions.html +[commit guidelines]: https://github.com/hexagonkt/.github/blob/master/commits.md + +It is recommended that you create a Git pre-push script to check the code before pushing it. As +this command will be executed before pushing code to the repository (saving you time fixing +[GitHub Actions] build errors). + +[GitHub Actions]: https://github.com/features/actions