-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update dependencies and pimp this repo with github community config f…
…iles
- Loading branch information
Showing
14 changed files
with
254 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
# Contributing | ||
|
||
## Commit messages | ||
Before writing a commit message read [this article](https://chris.beams.io/posts/git-commit/). | ||
|
||
## Build | ||
Before pushing any changes make sure project builds without errors with: | ||
``` | ||
./gradlew build | ||
``` | ||
|
||
## Code conventions | ||
This repository follows the [Kotlin coding conventions](https://kotlinlang.org/docs/reference/coding-conventions.html). | ||
That are enforced by ktlint and [.editorconfig](../.editorconfig). | ||
|
||
You can check style with: | ||
``` | ||
./gradlew ktlintCheck | ||
``` | ||
|
||
## Unit tests | ||
We use [JUnit 5](https://junit.org/junit5/docs/current/user-guide/) for testing. | ||
Please use the `Spec.kt` suffix on new test classes. | ||
|
||
## Validate changes locally | ||
Before submitting a pull request test your changes on a local project. | ||
There are few ways for testing locally a gradle plugin: | ||
|
||
**Publish plugin to the local maven repository** | ||
Publish plugin to local repository with: | ||
```sh | ||
./gradlew publishToMavenLocal | ||
``` | ||
|
||
...and add section to `settings.gradle.kts` to the sample project (that uses the tested plugin): | ||
```kt | ||
// Instruct a sample project to use maven local to find the plugin | ||
pluginManagement { | ||
repositories { | ||
mavenLocal() | ||
gradlePluginPortal() | ||
} | ||
} | ||
``` | ||
|
||
**Import plugin jar** | ||
Add plugin jar to the sample project (that uses the tested plugin): | ||
|
||
```kt | ||
buildscript { | ||
dependencies { | ||
classpath(files("<PLUGIN_PROJECT_PATH>/build/libs/manifest-plugin.jar")) | ||
} | ||
} | ||
|
||
apply(plugin = "com.coditory.build") | ||
``` | ||
|
||
## Validating plugin module metadata | ||
The easiest way to validate plugin's module metadata is to publish the plugin to a dummy local repository. | ||
|
||
Add to `build.gradle.kts`: | ||
``` | ||
publishing { | ||
repositories { | ||
maven { | ||
name = "localPluginRepository" | ||
url = uri("./local-plugin-repository") | ||
} | ||
} | ||
} | ||
``` | ||
|
||
...and publish the plugin with: | ||
``` | ||
./gradlew publish -Pversion=0.0.1 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
name: Bug report | ||
about: Reporting bugs and other issues | ||
labels: bug | ||
--- | ||
<!-- The bug you're experiencing might have already be reported! --> | ||
<!-- Please search in the [issues](https://github.com/coditory/gradle-manifest-plugin/issues) before creating one. --> | ||
|
||
## Context | ||
<!-- How has this issue affected you? What are you trying to accomplish? --> | ||
<!-- Providing context helps us come up with a solution that is most useful in the real world --> | ||
|
||
## Expected Behavior | ||
<!-- Tell us what should happen --> | ||
|
||
## Observed Behavior | ||
<!-- Tell us what happens instead of the expected behavior --> | ||
|
||
## Steps to Reproduce | ||
<!-- Provide a link to a live example, or an unambiguous set of steps to --> | ||
<!-- reproduce this bug. Include code to reproduce, if relevant --> | ||
|
||
## Your Environment | ||
<!-- Include as many relevant details about the environment you experienced the bug in --> | ||
* Plugin version: | ||
* Java (and/or Kotlin) version: | ||
* Gradle version: | ||
* Gradle scan link (add `--scan` option when running the gradle task): | ||
* Link to your project (if it's a public repository): |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
blank_issues_enabled: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest new features/changes | ||
labels: feature | ||
--- | ||
<!-- Your feature request may already be reported! --> | ||
<!-- Please search in the [issues](https://github.com/coditory/gradle-manifest-plugin/issues) before creating a new one. --> | ||
|
||
## Context | ||
<!--- What are you trying to accomplish? --> | ||
<!--- Providing context helps us come up with a solution that is most useful in the real world --> | ||
|
||
## Expected Behavior | ||
<!--- If you're suggesting a change/improvement, tell us how it should work --> | ||
<!--- Propose a solution --> | ||
|
||
## Current Behavior | ||
<!--- If suggesting a change/improvement, explain the difference from the current behavior if it exists --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
<!-- Thanks for submitting a pull request! --> | ||
## Changes | ||
<!-- Shortly describe what you want to accomplish with this PR --> | ||
<!-- Add a link to the issue if available --> | ||
|
||
## Checklist | ||
- [ ] I have tested that there is no similar [pull request](https://github.com/coditory/gradle-manifest-plugin/pulls) already submitted | ||
- [ ] I have read [contributing.md](https://github.com/coditory/gradle-manifest-plugin/blob/master/.github/CONTRIBUTING.md) and applied to the rules | ||
- [ ] I have unit tested code changes and performed a self-review | ||
- [ ] I have [tested plugin change locally](https://github.com/coditory/gradle-manifest-plugin/blob/master/.github/CONTRIBUTING.md#validate-changes-locally) on a sample project |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
source: | ||
- "src/**" | ||
|
||
build: | ||
- "**/*.gradle" | ||
- "**/*.gradle.kts" | ||
|
||
ci: | ||
- ".github/**" | ||
|
||
documentation: | ||
- "**/*.md" | ||
- "docs/**" | ||
|
||
license: | ||
- "LICENSE" | ||
|
||
gradle: | ||
- "gradlew" | ||
- "gradlew.bat" | ||
- ".gradle/**" | ||
- "gradle/**" | ||
|
||
git: | ||
- ".gitignore" | ||
|
||
style: | ||
- ".editorconfig" | ||
- ".idea/codeStyles/**" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,6 @@ | ||
name: Build | ||
|
||
on: | ||
workflow_dispatch: | ||
push: | ||
on: [pull_request, push, workflow_dispatch] | ||
|
||
jobs: | ||
build: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
name: "Pull Request" | ||
|
||
on: [pull_request_target] | ||
|
||
jobs: | ||
label-pr: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: read | ||
pull-requests: write | ||
steps: | ||
- uses: actions/labeler@v4 | ||
with: | ||
repo-token: "${{ secrets.GITHUB_TOKEN }}" | ||
|
||
dependabot: | ||
runs-on: ubuntu-latest | ||
if: ${{ github.event.pull_request.user.login == 'dependabot[bot]' }} | ||
permissions: | ||
pull-requests: write | ||
contents: write | ||
steps: | ||
- name: Dependabot metadata | ||
id: dependabot-metadata | ||
uses: dependabot/fetch-metadata@v1.3.1 | ||
|
||
- name: Enable auto-merge for Dependabot PRs | ||
run: gh pr merge --auto --rebase "$PR_URL" | ||
env: | ||
PR_URL: ${{ github.event.pull_request.html_url }} | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
- name: Approve patch and minor updates | ||
if: ${{ steps.dependabot-metadata.outputs.update-type != 'version-update:semver-major' }} | ||
run: gh pr review $PR_URL --approve -b "Pull request **approved** because **it includes a patch or minor update**" | ||
env: | ||
PR_URL: ${{ github.event.pull_request.html_url }} | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: 'Stale issues and PRs' | ||
on: | ||
schedule: | ||
- cron: '30 1 * * *' | ||
|
||
jobs: | ||
stale: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/stale@v7 | ||
with: | ||
# PRs | ||
stale-pr-message: 'This PR is stale because it has been open 120 days with no activity. Remove stale label or comment or this will be closed in 10 days.' | ||
days-before-pr-stale: 120 | ||
close-pr-message: 'This PR was closed because it has been stalled for 10 days with no activity.' | ||
days-before-pr-close: 10 | ||
exempt-all-pr-assignees: true | ||
exempt-pr-labels: 'awaiting-approval,work-in-progress' | ||
stale-pr-label: 'stale' | ||
# Issues | ||
stale-issue-message: 'This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 5 days.' | ||
days-before-issue-stale: 60 | ||
close-issue-message: 'This issue was closed because it has been stalled for 5 days with no activity.' | ||
days-before-issue-close: 5 | ||
exempt-issue-assignees: true | ||
exempt-issue-labels: 'awaiting-approval,work-in-progress' | ||
stale-issue-label: 'stale' |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters