forked from project-stacker/stacker
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add files related to project structure
Add required files towards proper project structure. Rename go module to stackerbuild.io/stacker. Signed-off-by: Ramkumar Chinchani <rchincha@cisco.com>
- Loading branch information
Showing
56 changed files
with
486 additions
and
88 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,40 @@ | ||
name: Bug report | ||
description: File a bug report | ||
title: "[Bug]: " | ||
labels: bug | ||
body: | ||
- type: input | ||
attributes: | ||
label: "stacker version" | ||
placeholder: "v0.0.1 or commit hash" | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: "Describe the bug" | ||
description: "Try to describe your issue/bug as well as you can, as that will help with speeding up fixing" | ||
|
||
- type: textarea | ||
attributes: | ||
label: "To reproduce" | ||
description: Steps to reproduce the behavior | ||
value: | | ||
1. Configuration | ||
2. Client tool used | ||
3. Seen error | ||
- type: textarea | ||
attributes: | ||
label: "Expected behavior" | ||
description: "A clear and concise description of what you expected to happen." | ||
|
||
- type: textarea | ||
attributes: | ||
label: "Screenshots" | ||
description: "If applicable, add screenshots to help explain your problem." | ||
|
||
- type: textarea | ||
attributes: | ||
label: "Additional context" | ||
description: "Add any other context about the problem here." |
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,24 @@ | ||
name: Feature request | ||
description: Request a feature | ||
title: "[Feat]: " | ||
labels: feature | ||
body: | ||
- type: textarea | ||
attributes: | ||
label: "Is your feature request related to a problem? Please describe." | ||
description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]" | ||
|
||
- type: textarea | ||
attributes: | ||
label: "Describe the solution you'd like" | ||
description: "A clear and concise description of what you want to happen." | ||
|
||
- type: textarea | ||
attributes: | ||
label: "Describe alternatives you've considered" | ||
description: "A clear and concise description of any alternative solutions or features you've considered." | ||
|
||
- type: textarea | ||
attributes: | ||
label: "Additional context" | ||
description: "Add any other context or screenshots about the feature request here." |
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,51 @@ | ||
<!-- Thanks for sending a pull request! Here are some tips for you: | ||
1. Ensure you have added the unit tests for your changes. | ||
2. Ensure you have included output of manual testing done in the Testing section. | ||
3. Ensure number of lines of code for new or existing methods are within the reasonable limit. | ||
--> | ||
**What type of PR is this?** | ||
|
||
<!-- | ||
Add one of the following: | ||
bug | ||
cleanup | ||
documentation | ||
feature | ||
--> | ||
|
||
**Which issue does this PR fix**: | ||
|
||
|
||
**What does this PR do / Why do we need it**: | ||
|
||
|
||
**If an issue # is not available please add repro steps and logs showing the issue**: | ||
|
||
|
||
**Testing done on this change**: | ||
<!-- | ||
output of manual testing/integration tests results and also attach logs | ||
showing the fix being resolved | ||
--> | ||
|
||
**Automation added to e2e**: | ||
<!-- | ||
Test case added to lib/integration.sh | ||
If no, create an issue with enhancement/testing label | ||
--> | ||
|
||
**Will this break upgrades or downgrades?** | ||
|
||
|
||
**Does this PR introduce any user-facing change?**: | ||
<!-- | ||
If yes, a release note update is required: | ||
Enter your extended release note in the block below. If the PR requires additional actions | ||
from users switching to the new release, include the string "action required". | ||
--> | ||
|
||
```release-note | ||
``` | ||
|
||
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. |
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,15 @@ | ||
# To get started with Dependabot version updates, you'll need to specify which | ||
# package ecosystems to update and where the package manifests are located. | ||
# Please see the documentation for all configuration options: | ||
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates | ||
|
||
version: 2 | ||
updates: | ||
- package-ecosystem: "gomod" # See documentation for possible values | ||
directory: "/" # Location of package manifests | ||
schedule: | ||
interval: "weekly" | ||
- package-ecosystem: "github-actions" # See documentation for possible values | ||
directory: "/" # Location of package manifests | ||
schedule: | ||
interval: "weekly" |
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,37 @@ | ||
name: "Lines of code statistics" | ||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
release: | ||
types: | ||
- published | ||
|
||
permissions: read-all | ||
|
||
jobs: | ||
loc: | ||
name: Lines of code | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Install go | ||
uses: actions/setup-go@v3 | ||
with: | ||
go-version: 1.19.x | ||
- name: Check out source code | ||
uses: actions/checkout@v3 | ||
- name: Install dependencies | ||
run: | | ||
cd $GITHUB_WORKSPACE | ||
go install github.com/hhatto/gocloc/cmd/gocloc@latest | ||
- name: All sources | ||
run: | | ||
cd $GITHUB_WORKSPACE | ||
gocloc . | ||
- name: All sources (except tests) | ||
run: | | ||
cd $GITHUB_WORKSPACE | ||
gocloc --not-match='.*_test.go' . |
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,106 @@ | ||
# For most projects, this workflow file will not need changing; you simply need | ||
# to commit it to your repository. | ||
# | ||
# You may wish to alter this file to override the set of languages analyzed, | ||
# or to provide custom queries or build logic. | ||
# | ||
# ******** NOTE ******** | ||
# We have attempted to detect the languages in your repository. Please check | ||
# the `language` matrix defined below to confirm you have the correct set of | ||
# supported CodeQL languages. | ||
# | ||
name: "CodeQL" | ||
|
||
on: | ||
push: | ||
branches: [ main ] | ||
pull_request: | ||
# The branches below must be a subset of the branches above | ||
branches: [ main ] | ||
schedule: | ||
- cron: '17 11 * * 0' | ||
|
||
permissions: read-all | ||
|
||
jobs: | ||
analyze: | ||
name: Analyze | ||
runs-on: ubuntu-latest | ||
permissions: | ||
actions: read | ||
contents: read | ||
security-events: write | ||
strategy: | ||
fail-fast: false | ||
matrix: | ||
language: [ 'go' ] | ||
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] | ||
# Learn more: | ||
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed | ||
env: | ||
CGO_ENABLED: 0 | ||
GOFLAGS: "-tags=sync,search,scrub,metrics,containers_image_openpgp" | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
- name: Install go | ||
uses: actions/setup-go@v3 | ||
with: | ||
go-version: 1.19.x | ||
|
||
- name: Install dependencies | ||
run: | | ||
cd $GITHUB_WORKSPACE | ||
go install github.com/swaggo/swag/cmd/swag@latest | ||
go mod download | ||
go install github.com/wadey/gocovmerge@latest | ||
go get -u github.com/swaggo/swag/cmd/swag | ||
go mod download | ||
sudo apt-get update | ||
sudo apt-get -y install rpm uidmap | ||
# install skopeo | ||
. /etc/os-release | ||
echo "deb https://download.opensuse.org/repositories/devel:/kubic:/libcontainers:/stable/xUbuntu_${VERSION_ID}/ /" | sudo tee /etc/apt/sources.list.d/devel:kubic:libcontainers:stable.list | ||
curl -L https://download.opensuse.org/repositories/devel:/kubic:/libcontainers:/stable/xUbuntu_${VERSION_ID}/Release.key | sudo apt-key add - | ||
sudo apt-get update | ||
sudo apt-get -y upgrade | ||
sudo apt-get -y install skopeo | ||
# install notation | ||
curl -Lo notation.tar.gz https://github.com/notaryproject/notation/releases/download/v0.7.1-alpha.1/notation_0.7.1-alpha.1_linux_amd64.tar.gz | ||
sudo tar xvzf notation.tar.gz -C /usr/bin notation | ||
# install oras | ||
curl -LO https://github.com/oras-project/oras/releases/download/v0.14.0/oras_0.14.0_linux_amd64.tar.gz | ||
mkdir -p oras-install/ | ||
tar -zxf oras_0.14.0_*.tar.gz -C oras-install/ | ||
sudo mv oras-install/oras /usr/bin/ | ||
rm -rf oras_0.14.0_*.tar.gz oras-install/ | ||
# Initializes the CodeQL tools for scanning. | ||
- name: Initialize CodeQL | ||
uses: github/codeql-action/init@v2 | ||
with: | ||
languages: ${{ matrix.language }} | ||
# If you wish to specify custom queries, you can do so here or in a config file. | ||
# By default, queries listed here will override any specified in a config file. | ||
# Prefix the list here with "+" to use these queries and those in the config file. | ||
# queries: ./path/to/local/query, your-org/your-repo/queries@main | ||
|
||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java). | ||
# If this step fails, then you should remove it and run the build manually (see below) | ||
- name: Autobuild | ||
uses: github/codeql-action/autobuild@v2 | ||
|
||
# ℹ️ Command-line programs to run using the OS shell. | ||
# 📚 https://git.io/JvXDl | ||
|
||
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines | ||
# and modify them (or add more) to build your code if your project | ||
# uses a compiled language | ||
#- run: | | ||
# make bootstrap | ||
# make release | ||
|
||
- name: Perform CodeQL Analysis | ||
uses: github/codeql-action/analyze@v2 |
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: 'Check commit message style' | ||
on: | ||
pull_request: | ||
types: | ||
- opened | ||
- edited | ||
- reopened | ||
- synchronize | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
check-commit-message-style: | ||
name: Check commit message style | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v2 | ||
- name: Check Commit Type | ||
uses: gsactions/commit-message-checker@v2 | ||
with: | ||
pattern: '^((build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\(.+\))?(!)?(: (.*\s*)*))' | ||
flags: 'gm' | ||
error: 'Your first line has to the Conventional Commits specification.' | ||
excludeDescription: 'true' # optional: this excludes the description body of a pull request | ||
excludeTitle: 'true' # optional: this excludes the title of a pull request | ||
checkAllCommitMessages: 'true' | ||
accessToken: ${{ secrets.GITHUB_TOKEN }} | ||
- name: Check Line Length | ||
uses: gsactions/commit-message-checker@v2 | ||
with: | ||
pattern: '^[^#].{1,74}' | ||
error: 'The maximum line length of 74 characters is exceeded.' | ||
excludeDescription: 'true' # optional: this excludes the description body of a pull request | ||
excludeTitle: 'true' # optional: this excludes the title of a pull request | ||
checkAllCommitMessages: 'true' # optional: this checks all commits associated with a pull request | ||
accessToken: ${{ secrets.GITHUB_TOKEN }} # github access token is only required if checkAllCommitMessages is true |
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,24 @@ | ||
# .github/workflows/dco.yml | ||
name: DCO | ||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
permissions: read-all | ||
|
||
jobs: | ||
check: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Set up Python 3.x | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: '3.x' | ||
- name: Check DCO | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
run: | | ||
pip3 install -U dco-check | ||
dco-check |
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: 'Close stale issues and PRs' | ||
on: | ||
schedule: | ||
- cron: '30 1 * * *' | ||
|
||
permissions: | ||
contents: read | ||
issues: write | ||
pull-requests: write | ||
|
||
jobs: | ||
stale: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/stale@v6 | ||
with: | ||
stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.' | ||
stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.' | ||
close-issue-message: 'This issue was closed because it has been stalled for 5 days with no activity.' | ||
close-pr-message: 'This PR was closed because it has been stalled for 10 days with no activity.' | ||
days-before-issue-stale: 30 | ||
days-before-pr-stale: 45 | ||
days-before-issue-close: 5 | ||
days-before-pr-close: 10 | ||
stale-issue-label: 'no-issue-activity' | ||
exempt-issue-labels: 'awaiting-approval,work-in-progress' | ||
stale-pr-label: 'no-pr-activity' | ||
exempt-pr-labels: 'awaiting-approval,work-in-progress' | ||
only-labels: 'awaiting-feedback,awaiting-answers' |
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,4 @@ | ||
# This is a comment. | ||
# Each line is a file pattern followed by one or more owners. | ||
|
||
* @rchincha @smoser @hallyn @peusebiu |
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,3 @@ | ||
## Community Code of Conduct | ||
|
||
stacker follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). |
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 @@ | ||
See [Contributing Guide](https://stackerbuild.io/developer_guide/CONTRIBUTING/) for instructions and guidelines. |
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,11 @@ | ||
# stacker Maintainers | ||
|
||
## Maintainers | ||
|
||
| Maintainer | Github ID | Affiliation | | ||
| --------------- | --------- | ----------- | | ||
| Ramkumar Chinchani | [rchincha](https://github.com/rchincha) | [Cisco Systems](https://www.cisco.com) | | ||
| Scott Moser | [smosert](https://github.com/smoser) | [Cisco Systems](https://www.cisco.com) | | ||
| Serge Hallyn | [hallyn](https://github.com/hallyn) | [Cisco Systems](https://www.cisco.com) | | ||
| Petu Constantin Eusebiu | [peusebiu](https://github.com/peusebiu) | [Cisco Systems](https://www.cisco.com) | ||
| Tycho Andersen | [tych0](https://github.com/tych0) | [Netflix](https://www.netflix.com) | |
Oops, something went wrong.