From 893d11309dec4f5a18ae4bf4455269679bb359b5 Mon Sep 17 00:00:00 2001 From: "Daniel A. A. Pelsmaeker" Date: Sat, 27 Jul 2024 01:28:18 +0200 Subject: [PATCH] Update repo files using repoman --- .github/workflows/build.yaml | 10 ++- .gitignore | 2 + CODE_OF_CONDUCT.md | 133 +++++++++++++++++++++++++++++++++++ CONTRIBUTING.md | 55 +++++++++++++++ README.md | 27 +++---- repo.yaml | 22 ++++++ 6 files changed, 230 insertions(+), 19 deletions(-) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 repo.yaml diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index e1e2dde..c41bd03 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -10,11 +10,15 @@ on: # yamllint disable-line rule:truthy jobs: build: uses: metaborg/actions/.github/workflows/gradle-build-matrix.yaml@main + with: + gradle-command: | + gradle build +# Publish snapshots publish-snapshot: uses: metaborg/actions/.github/workflows/gradle-publish.yaml@main with: gradle-command: | - gradle :publish -Pgitonium.isSnapshot=true + gradle publish -Pgitonium.isSnapshot=true gradle-version-command: | gradle -q :printVersion -Pgitonium.isSnapshot=true if: "github.event_name == 'push' && github.ref == 'refs/heads/main'" @@ -22,11 +26,12 @@ jobs: secrets: METABORG_ARTIFACTS_USERNAME: ${{ secrets.METABORG_ARTIFACTS_USERNAME }} METABORG_ARTIFACTS_PASSWORD: ${{ secrets.METABORG_ARTIFACTS_PASSWORD }} +# Publish releases publish-release: uses: metaborg/actions/.github/workflows/gradle-publish.yaml@main with: gradle-command: | - gradle :publish + gradle publish gradle-version-command: | gradle -q :printVersion if: "github.event_name == 'push' && startsWith(github.ref, 'refs/tags/release-')" @@ -34,4 +39,3 @@ jobs: secrets: METABORG_ARTIFACTS_USERNAME: ${{ secrets.METABORG_ARTIFACTS_USERNAME }} METABORG_ARTIFACTS_PASSWORD: ${{ secrets.METABORG_ARTIFACTS_PASSWORD }} - diff --git a/.gitignore b/.gitignore index 569ad27..c3b0106 100644 --- a/.gitignore +++ b/.gitignore @@ -68,3 +68,5 @@ local.properties .cache .DS_Store *.lock +jte-classes/ + diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..7a152d8 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,133 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, +and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall +community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of +any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, +without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a +professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b2f97e5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Metaborg Git + +## How to Contribute +Thank you for wanting to contribute to this project! :tada::+1: + +> **Note**: +> We may not deal with your issue or pull request in a timely manner, or at all. +> We also reserve the right to change your contribution in any way we deem fit +> for this project, or even outright reject it. + +#### **You have a question?** +Search the [Discussions][1] and [Stackoverflow][3] to see whether your question +has already been answered, or ask your question there. +Please do **not** make an issue on the Github repository. + + +#### **You found a bug** +Search the [Issues][2] to ensure the bug has not been reported before. + +If the bug is new, open a new issue with a _clear title and description_. +Please indicate: +- what you did, +- what you expected to happen, and +- what actually happened. + +Try to include as much relevant information as you have. +For example, a code sample or executable test case are very helpful. + + +#### **You wrote a patch with a cosmetic change** +Please do not submit pull requests for cosmetic changes, +such as whitespace and formatting changes. +We will reject them. + + +#### **You wrote a patch with a bug fix** +Thank you! Please open a GitHub pull request with the patch. + + +#### **You wrote a patch that adds a new feature or changes an existing one** +Please open an issue _first_, so we can discuss the change. + + +#### **You want to contribute to the documentation or test suite** +Thank you! Please open a GitHub pull request with the patch. + +--- + +Thanks! :heart: :heart: :heart: + +[Programming Languages Group](https://pl.ewi.tudelft.nl/), [Delft University of Technology](https://www.tudelft.nl/) + +[1]: https://github.com/metaborg/metaborg-git/discussions +[2]: https://github.com/metaborg/metaborg-git/issues +[3]: https://stackoverflow.com/ diff --git a/README.md b/README.md index b77ab3f..6c2c12b 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@ -# Metaborg Git Library +# Metaborg Git [![Build][github-badge:build]][github:build] [![License][license-badge]][license] [![GitHub Release][github-badge:release]][github:release] -[![Documentation][documentation-badge]][documentation] A library for interacting with Git. -| Artifact | Latest Release | Latest Snapshot | -|---------------------|------------------------------------------|--------------------------------------------| -| `org.metaborg:git` | [![Release][mvn-rel-badge:git]][mvn:git] | [![Snapshot][mvn-snap-badge:git]][mvn:git] | - + + +| Artifact | Latest Release | Latest Snapshot | +|----------|----------------|-----------------| +| `org.metaborg:git` | [![Release][mvn-rel-badge:org.metaborg:git]][mvn:org.metaborg:git] | [![Snapshot][mvn-snap-badge:org.metaborg:git]][mvn:org.metaborg:git] | + ## License Copyright 2024 [Programming Languages Group](https://pl.ewi.tudelft.nl/), [Delft University of Technology](https://www.tudelft.nl/) @@ -18,19 +19,13 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an **"as is" basis, without warranties or conditions of any kind**, either express or implied. See the License for the specific language governing permissions and limitations under the License. - - [github-badge:build]: https://img.shields.io/github/actions/workflow/status/metaborg/metaborg-git/build.yaml [github:build]: https://github.com/metaborg/metaborg-git/actions [license-badge]: https://img.shields.io/github/license/metaborg/metaborg-git -[license]: https://github.com/metaborg/metaborg-git/blob/main/LICENSE +[license]: https://github.com/metaborg/metaborg-git/blob/main/LICENSE.md [github-badge:release]: https://img.shields.io/github/v/release/metaborg/metaborg-git?display_name=release [github:release]: https://github.com/metaborg/metaborg-git/releases -[documentation-badge]: https://img.shields.io/badge/docs-latest-brightgreen -[documentation]: https://spoofax.dev/metaborg-git/ -[documentation-button]: https://img.shields.io/badge/Documentation-blue?style=for-the-badge&logo=googledocs&logoColor=white - -[mvn:git]: https://artifacts.metaborg.org/#nexus-search;gav~org.metaborg~git~~~ -[mvn-rel-badge:git]: https://img.shields.io/nexus/r/org.metaborg/git?server=https%3A%2F%2Fartifacts.metaborg.org&label=%20 -[mvn-snap-badge:git]: https://img.shields.io/nexus/s/org.metaborg/git?server=https%3A%2F%2Fartifacts.metaborg.org&label=%20 +[mvn:org.metaborg:git]: https://artifacts.metaborg.org/#nexus-search;gav~org.metaborg~git~~~ +[mvn-rel-badge:org.metaborg:git]: https://img.shields.io/nexus/r/org.metaborg/git?server=https%3A%2F%2Fartifacts.metaborg.org&label=%20 +[mvn-snap-badge:org.metaborg:git]: https://img.shields.io/nexus/s/org.metaborg/git?server=https%3A%2F%2Fartifacts.metaborg.org&label=%20 diff --git a/repo.yaml b/repo.yaml new file mode 100644 index 0000000..260c600 --- /dev/null +++ b/repo.yaml @@ -0,0 +1,22 @@ +--- +repoOwner: "metaborg" +repoName: "metaborg-git" + +title: "Metaborg Git" +description: | + A library for interacting with Git. +inceptionYear: "2024" + +libraries: + - group: "org.metaborg" + name: "git" + description: "Metaborg Git library" + +developers: + - id: "Virtlink" + name: "Daniel A. A. Pelsmaeker" + +files: + githubWorkflows: + publishRelease: true + publishSnapshot: true