From ff1bbe88bd82e3398e07b3391d6cd7f337270434 Mon Sep 17 00:00:00 2001 From: Karanraj Chauhan Date: Tue, 26 Oct 2021 12:41:37 -0400 Subject: [PATCH] Add GH issue template decsriptions from project-template. This commit pulls in the changes in project-template from the https://github.com/aicoe-aiops/project-template/pull/46 PR. Original author of the content of this PR is pacospace. Co-authored-by: Francesco Murdaca --- .../.github/ISSUE_TEMPLATE/major-release.md | 7 ++ .../.github/ISSUE_TEMPLATE/minor-release.md | 6 ++ .../.github/ISSUE_TEMPLATE/patch-release.md | 6 ++ .../redeliver_container_image.md | 5 ++ {{ cookiecutter.repo_name }}/README.md | 77 +++++++++++-------- 5 files changed, 71 insertions(+), 30 deletions(-) diff --git a/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/major-release.md b/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/major-release.md index 49d45369e..f0aa0b509 100644 --- a/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/major-release.md +++ b/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/major-release.md @@ -9,3 +9,10 @@ labels: bot Hey, Kebechet! Create a new major release, please. + + +**IMPORTANT NOTES** + +- _If [Khebut GitHub App Bot](https://github.com/apps/khebhut) is installed, this issue will trigger a major release. The bot will open a Pull Request to update the CHANGELOG, fix the opened issue and create a tag._ + +- _Only users that are allowed to release (a.k.a. maintainers specified in the .thoth.yaml file) can open the issue, otherwise bot will reject them, commenting and closing the issue. If [AICoE CI GitHub App](https://github.com/apps/aicoe-ci) is installed, once the pull request is merged and a new tag is created by the bot, the pipeline to build and push image starts._ diff --git a/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/minor-release.md b/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/minor-release.md index 27262e67c..15c1e9c4f 100644 --- a/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/minor-release.md +++ b/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/minor-release.md @@ -9,3 +9,9 @@ labels: bot Hey, Kebechet! Create a new minor release, please. + +**IMPORTANT NOTES** + +- _If [Khebut GitHub App Bot](https://github.com/apps/khebhut) is installed, this issue will trigger a minor release. The bot will open a Pull Request to update the CHANGELOG, fix the opened issue and create a tag._ + +- _Only users that are allowed to release (a.k.a. maintainers specified in the .thoth.yaml file) can open the issue, otherwise bot will reject them, commenting and closing the issue. If [AICoE CI GitHub App](https://github.com/apps/aicoe-ci) is installed, once the pull request is merged and a new tag is created by the bot, the pipeline to build and push image starts._ diff --git a/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/patch-release.md b/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/patch-release.md index fae0f2589..4b0137867 100644 --- a/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/patch-release.md +++ b/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/patch-release.md @@ -9,3 +9,9 @@ labels: bot Hey, Kebechet! Create a new patch release, please. + +**IMPORTANT NOTES** + +- _If [Khebut GitHub App Bot](https://github.com/apps/khebhut) is installed, this issue will trigger a patch release. The bot will open a Pull Request to update the CHANGELOG, fix the opened issue and create a tag._ + +- _Only users that are allowed to release (a.k.a. maintainers specified in the .thoth.yaml file) can open the issue, otherwise bot will reject them, commenting and closing the issue. If [AICoE CI GitHub App](https://github.com/apps/aicoe-ci) is installed, once the pull request is merged and a new tag is created by the bot, the pipeline to build and push image starts._ diff --git a/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/redeliver_container_image.md b/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/redeliver_container_image.md index 3b88e50cc..1e2773afb 100644 --- a/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/redeliver_container_image.md +++ b/{{ cookiecutter.repo_name }}/.github/ISSUE_TEMPLATE/redeliver_container_image.md @@ -11,3 +11,8 @@ Hey, AICoE-CI! Please build and deliver the following git tag: Tag: x.y.z + + +**IMPORTANT NOTES** + +- _If the tag exists and [AICoE CI GitHub App](https://github.com/apps/aicoe-ci) is installed, this issue will retrigger the pipeline to build from tag and push image container image. It should be used if the pipeline triggered with the {major|minor|patch} release failed for any reason._ diff --git a/{{ cookiecutter.repo_name }}/README.md b/{{ cookiecutter.repo_name }}/README.md index 558e2d6d5..baac352f6 100644 --- a/{{ cookiecutter.repo_name }}/README.md +++ b/{{ cookiecutter.repo_name }}/README.md @@ -1,57 +1,74 @@ -{{cookiecutter.project_name}} +project-template ============================== -{{cookiecutter.description}} +template for the team to use Project Organization ------------ ├── LICENSE - ├── Makefile <- Makefile with commands like `make data` or `make train` - ├── Pipfile <- Pipfile stating package configuration as used by Pipenv. - ├── Pipfile.lock <- Pipfile.lock stating a pinned down software stack with as used by Pipenv. - ├── README.md <- The top-level README for developers using this project. + ├── Makefile <- Makefile with commands like `make data` or `make train` + ├── Pipfile <- Pipfile stating package configuration as used by Pipenv. + ├── Pipfile.lock <- Pipfile.lock stating a pinned down software stack with as used by Pipenv. + ├── README.md <- The top-level README for developers using this project. ├── data - │   ├── external <- Data from third party sources. - │   ├── interim <- Intermediate data that has been transformed. - │   ├── processed <- The final, canonical data sets for modeling. - │   └── raw <- The original, immutable data dump. + │   ├── external <- Data from third party sources. + │   ├── interim <- Intermediate data that has been transformed. + │   ├── processed <- The final, canonical data sets for modeling. + │   └── raw <- The original, immutable data dump. │ - ├── docs <- A default Sphinx project; see sphinx-doc.org for details + ├── docs <- A default Sphinx project; see sphinx-doc.org for details │ - ├── models <- Trained and serialized models, model predictions, or model summaries + ├── models <- Trained and serialized models, model predictions, or model summaries │ - ├── notebooks <- Jupyter notebooks. Naming convention is a number (for ordering), - │ the creator's initials, and a short `-` delimited description, e.g. - │ `1.0-jqp-initial-data-exploration`. + ├── notebooks <- Jupyter notebooks. Naming convention is a number (for ordering), + │ the creator's initials, and a short `-` delimited description, e.g. + │ `1.0-jqp-initial-data-exploration`. │ - ├── references <- Data dictionaries, manuals, and all other explanatory materials. + ├── references <- Data dictionaries, manuals, and all other explanatory materials. │ - ├── reports <- Generated analysis as HTML, PDF, LaTeX, etc. - │   └── figures <- Generated graphics and figures to be used in reporting + ├── reports <- Generated analysis as HTML, PDF, LaTeX, etc. + │   └── figures <- Generated graphics and figures to be used in reporting │ - ├── setup.py <- makes project pip installable (pip install -e .) so src can be imported - ├── src <- Source code for use in this project. - │   ├── __init__.py <- Makes src a Python module + ├── requirements.txt <- The requirements file stating direct dependencies if a library + │ is developed. + │ + ├── setup.py <- makes project pip installable (pip install -e .) so src can be imported + ├── src <- Source code for use in this project. + │   ├── __init__.py <- Makes src a Python module │ │ - │   ├── data <- Scripts to download or generate data + │   ├── data <- Scripts to download or generate data │   │   └── make_dataset.py │ │ - │   ├── features <- Scripts to turn raw data into features for modeling + │   ├── features <- Scripts to turn raw data into features for modeling │   │   └── build_features.py │ │ - │   ├── models <- Scripts to train models and then use trained models to make - │ │ │ predictions + │   ├── models <- Scripts to train models and then use trained models to make + │ │ │ predictions │   │   ├── predict_model.py │   │   └── train_model.py │ │ - │   └── visualization <- Scripts to create exploratory and results oriented visualizations + │   └── visualization <- Scripts to create exploratory and results oriented visualizations │   └── visualize.py │ - ├── .thoth.yaml <- Thoth's configuration file - ├── .aicoe-ci.yaml <- AICoE CI configuration file (https://github.com/AICoE/aicoe-ci) - └── tox.ini <- tox file with settings for running tox; see tox.readthedocs.io - + ├── .thoth.yaml <- Thoth's configuration file + ├── .aicoe-ci.yaml <- AICoE CI configuration file (https://github.com/AICoE/aicoe-ci) + │ + ├── .github <- GitHub configuration folder + │   ├── PULL_REQUEST_TEMPLATE <- GitHub templates for pull requests + │ │ + │   ├── ISSUE_TEMPLATE <- GitHub templates for issues + | ├── {major|minor|patch}_release.md <- If Khebut GitHub App Bot (https://github.com/apps/khebhut) is installed, the issue will trigger a major|minor|patch release. + │ | The bot will open a Pull Request to update the CHANGELOG and fix the opened issue. + │ | NOTE: only users that are allowed to release (a.k.a. maintainers specified in the .thoth.yaml file) should open the issue, otherwise bot will + │ | reject them, commenting and closing the issue. + │ | If AICoE CI GitHub App (https://github.com/apps/aicoe-ci) is installed, once the pull request is merged a new tag is created by the bot + │ | and the pipeline to build and push image starts. + │ | + | └── redeliver_container_image.md <- If the tag exists and AICoE CI GitHub App (https://github.com/apps/aicoe-ci) is installed, the issue will retrigger the pipeline to build and + │ push image container image. NOTE: It should be used if the pipeline triggered with the {major|minor|patch}_release failed for any reason. + | + └── tox.ini <- tox file with settings for running tox; see tox.readthedocs.io --------