-
Notifications
You must be signed in to change notification settings - Fork 90
docs: init documentation #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
563ecdc
docs: Init project documentation
stevehouel 9a436e3
docs: Improving README file
stevehouel 17598e8
fix: Fix Readme.md documentation and remove unecessary parts.
stevehouel ab1eadf
ci: Improve docs build phase and test dependencies
stevehouel 394d432
fix: docs pipeline
stevehouel 527e61f
ci: Remove Java 6 support test on ci pipeline
stevehouel 15fa2e0
fix: Rename Java ArtifactId and GroupId to be compliant with new AWS …
stevehouel 8736629
docs: update maven artifactId and groupId to new one
stevehouel 6782524
ci: Remove Java 6 support test on ci pipeline (+6 squashed commits)
stevehouel 009d21d
Merge branch 'master' of https://github.com/stevehouel/aws-lambda-pow…
stevehouel 33b133f
ci: remove unused deploy file
stevehouel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,46 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: bug, triage | ||
assignees: '' | ||
|
||
--- | ||
|
||
<!--- Provide a general summary of the issue in the Title above --> | ||
<!--- How has this issue affected you? What are you trying to accomplish? --> | ||
|
||
**What were you trying to accomplish?** | ||
|
||
## Expected Behavior | ||
<!--- If you're describing a bug, tell us what should happen --> | ||
<!--- If you're suggesting a change/improvement, tell us how it should work --> | ||
|
||
## Current Behavior | ||
<!--- If describing a bug, tell us what happens instead of the expected behavior --> | ||
<!--- If suggesting a change/improvement, explain the difference from current behavior --> | ||
|
||
## Possible Solution | ||
<!--- Not obligatory, but suggest a fix/reason for the bug, --> | ||
<!--- or ideas how to implement the addition or change --> | ||
|
||
## Steps to Reproduce (for bugs) | ||
<!--- Provide a link to a live example, or an unambiguous set of steps to --> | ||
<!--- reproduce this bug. Include code to reproduce, if relevant --> | ||
1. | ||
2. | ||
3. | ||
4. | ||
|
||
## Environment | ||
|
||
* **Powertools version used**: | ||
* **Packaging format (Layers, Maven/Gradle)**: | ||
* **AWS Lambda function runtime:** | ||
* **Debugging logs** | ||
|
||
> [How to enable debug mode](https://awslabs.github.io/aws-lambda-powertools-java/#debug-mode)** | ||
|
||
```python | ||
# paste logs here | ||
``` |
This file contains hidden or 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,17 @@ | ||
--- | ||
name: Documentation improvements | ||
about: Suggest a documentation update | ||
title: '' | ||
labels: documentation | ||
assignees: '' | ||
|
||
--- | ||
|
||
**What were you initially searching for in the docs?** | ||
<!-- Please help us understand how you looked for information that was either not available or unclear --> | ||
|
||
**Is this related to an existing part of the documentation? Please share a link** | ||
|
||
**Describe how we could make it clearer** | ||
|
||
**If you have a proposed update, please share it here** |
This file contains hidden or 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,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: feature-request, triage | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] --> | ||
|
||
**Describe the solution you'd like** | ||
<!-- A clear and concise description of what you want to happen. --> | ||
|
||
**Describe alternatives you've considered** | ||
<!-- A clear and concise description of any alternative solutions or features you've considered. --> | ||
|
||
**Additional context** | ||
<!-- Add any other context or screenshots about the feature request here. --> |
This file contains hidden or 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,52 @@ | ||
--- | ||
name: RFC | ||
about: Feature design and proposals | ||
title: 'RFC: ' | ||
labels: RFC, triage | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Key information | ||
|
||
* RFC PR: (leave this empty) | ||
* Related issue(s), if known: | ||
* Area: (i.e. Tracer, Metrics, Logger, etc.) | ||
* Meet [tenets](https://awslabs.github.io/aws-lambda-powertools-java/#tenets): (Yes/no) | ||
|
||
## Summary | ||
[summary]: #summary | ||
|
||
> One paragraph explanation of the feature. | ||
|
||
## Motivation | ||
[motivation]: #motivation | ||
|
||
> Why are we doing this? What use cases does it support? What is the expected outcome? | ||
|
||
## Proposal | ||
[proposal]: #proposal | ||
|
||
> This is the bulk of the RFC. | ||
|
||
> Explain the design in enough detail for somebody familiar with Powertools to understand it, and for somebody familiar with the implementation to implement it. | ||
|
||
> This should get into specifics and corner-cases, and include examples of how the feature is used. Any new terminology should be defined here. | ||
|
||
## Drawbacks | ||
[drawbacks]: #drawbacks | ||
|
||
> Why should we *not* do this? | ||
|
||
> Do we need additional dependencies? Impact performance/package size? | ||
|
||
## Rationale and alternatives | ||
[rationale-and-alternatives]: #rationale-and-alternatives | ||
|
||
* **What other designs have been considered? Why not them?** | ||
* **What is the impact of not doing this?** | ||
|
||
## Unresolved questions | ||
[unresolved-questions]: #unresolved-questions | ||
|
||
> Optional, stash area for topics that need further development e.g. TBD |
This file contains hidden or 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,25 @@ | ||
**Issue #, if available:** | ||
|
||
## Description of changes: | ||
|
||
<!--- One or two sentences as a summary of what's being changed --> | ||
|
||
**Checklist** | ||
|
||
<!--- Leave unchecked if your change doesn't seem to apply --> | ||
|
||
* [ ] [Meet tenets criteria](https://awslabs.github.io/aws-lambda-powertools-java/#tenets) | ||
* [ ] Update tests | ||
* [ ] Update docs | ||
* [ ] PR title follows [conventional commit semantics]() | ||
|
||
## Breaking change checklist | ||
|
||
<!--- Ignore if it's not a breaking change --> | ||
|
||
**RFC issue #**: | ||
|
||
* [ ] Migration process documented | ||
* [ ] Implement warnings (if it can live side by side) | ||
|
||
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. |
This file contains hidden or 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,35 @@ | ||
change-template: "* $TITLE (#$NUMBER) by @$AUTHOR" | ||
categories: | ||
- title: '⚡ Breaking Changes' | ||
labels: | ||
- 'breaking-change' | ||
- title: '🌟New features and non-breaking changes' | ||
labels: | ||
- 'major' | ||
- 'feature' | ||
- title: '🌟 Minor Changes' | ||
labels: | ||
- 'enhancement' | ||
- title: '📜 Documentation updates' | ||
labels: | ||
- 'documentation' | ||
- title: '🐛 Bug and hot fixes' | ||
labels: | ||
- 'bug' | ||
- 'fix' | ||
- title: '🚒 Deprecations' | ||
labels: | ||
- 'deprecated' | ||
exclude-labels: | ||
- 'skip-changelog' | ||
tag-template: 'v$NEXT_PATCH_VERSION' | ||
template: | | ||
## Changes | ||
|
||
**[Human readable summary of changes]** | ||
|
||
$CHANGES | ||
|
||
## This release was made possible by the following contributors: | ||
|
||
$CONTRIBUTORS |
This file contains hidden or 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,19 @@ | ||
# conventional commit types: https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json | ||
types: | ||
- feat | ||
- fix | ||
- docs | ||
- style | ||
- refactor | ||
- perf | ||
- test | ||
- build | ||
- ci | ||
- chore | ||
- revert | ||
- improv | ||
|
||
# Always validate the PR title | ||
# and ignore the commits to lower the entry bar for contribution | ||
# while titles make up the Release notes to ease maintenance overhead | ||
titleOnly: true |
This file contains hidden or 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,17 @@ | ||
only: issues | ||
daysUntilStale: 30 | ||
daysUntilClose: 7 | ||
exemptLabels: | ||
- bug | ||
- documentation | ||
- enhancement | ||
- feature-request | ||
- RFC | ||
staleLabel: pending-close-response-required | ||
markComment: > | ||
This issue has been automatically marked as stale because it has not had | ||
recent activity. It will be closed if no further activity occurs. Thank you | ||
for your contributions. | ||
closeComment: > | ||
This issue has been automatically closed because of inactivity. | ||
Please open a new issue if you are still encountering problems. |
This file contains hidden or 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,47 @@ | ||
name: Build | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- master | ||
push: | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
strategy: | ||
max-parallel: 4 | ||
matrix: | ||
# test against latest update of each major Java version, as well as specific updates of LTS versions: | ||
java: [ 1.6, 6.0.83, 7, 7.0.181, 8, 8.0.192, 9.0.x, 10, 11.0.x, 11.0.3, 12, 13 ] | ||
msailes marked this conversation as resolved.
Show resolved
Hide resolved
|
||
name: Java ${{ matrix.java }} | ||
env: | ||
OS: ${{ matrix.os }} | ||
JAVA: ${{ matrix.java-version }} | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Setup java | ||
uses: actions/setup-java@v1 | ||
with: | ||
java-version: ${{ matrix.java }} | ||
- name: Build with Maven | ||
run: mvn -B package --file pom.xml -P release-github | ||
- name: Publish to GitHub Packages Apache Maven | ||
run: mvn deploy -P release-github | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GITHUB_TOKEN is the default env for the password | ||
|
||
|
||
# - name: Set up Apache Maven Central | ||
# uses: actions/setup-java@v1 | ||
# with: # running setup-java again overwrites the settings.xml | ||
# java-version: 1.8 | ||
# server-id: maven # Value of the distributionManagement/repository/id field of the pom.xml | ||
# server-username: MAVEN_USERNAME # env variable for username in deploy | ||
# server-password: MAVEN_CENTRAL_TOKEN # env variable for token in deploy | ||
# | ||
# - name: Publish to Apache Maven Central | ||
# run: mvn deploy -P release-maven | ||
# env: | ||
# MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }} | ||
# MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_TOKEN }} |
This file contains hidden or 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,33 @@ | ||
name: Docs | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- master | ||
push: | ||
branches: | ||
- master | ||
# Disabled until docs support versioning per branch/release | ||
# - develop | ||
|
||
jobs: | ||
docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v1 | ||
- name: Set up Python | ||
uses: actions/setup-python@v1 | ||
with: | ||
python-version: "3.8" | ||
- name: Capture branch and tag | ||
id: branch_name | ||
run: | | ||
echo ::set-env name=SOURCE_BRANCH::${GITHUB_REF#refs/heads/} | ||
echo ::set-env name=SOURCE_TAG::${GITHUB_REF#refs/tags/} | ||
- name: Build docs website | ||
run: make build-docs-website | ||
- name: Deploy all docs | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: ./dist |
This file contains hidden or 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,15 @@ | ||
name: Release Drafter | ||
|
||
on: | ||
push: | ||
# branches to consider in the event; optional, defaults to all | ||
branches: | ||
- develop | ||
|
||
jobs: | ||
update_release_draft: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: release-drafter/release-drafter@v5 | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.