coding-projects-template

Template to coding projects that requires a conventional workflow

[](https://github.com/mauroalderete/coding-projects-template/actions/workflows/tests.yml) [](https://github.com/mauroalderete/coding-projects-template/actions/workflows/codeql-analysis.yml) Report Bug · Request Feature

:wave: Introducing `coding-projects-templates

This repository template contains the essential elements used in various projects to many stacks.

• Includes workflows to handle labeling, versioning, testing
• Contains a private license, a basic contributing redaction, and a covenant code of conduct.
• Implements a definition to generate release notes.
• Defines templates to the three issues types (bug, proposal, question) and a pull request template.
• Additional prepare a dependabot script.
• Schedule a CodeQL Analysis.

Many of the configuration files in this repository are not working yet. Just consist of a sample definition of the configuration. You may adapt these files depending on your objectives. You should pay attention to subsequent indications to know how you do it.

:fire: How to use this template

To use this template, click the button Use this template shown in the upper section on root of repository, then create a new repository.

Another way is initing the process of creating a new repository and selecting this template in the upper section.

:building_construction: How to Set up

This template contains many files. A lot of them require special attention.

CodeQL

/.github/workflows/codeql-analysis.yml

This file enables the CodeQL service provided by GitHub. You should provide a language supported. If your project is not supported, I recommend removing this yaml file.

Code of conduct

/CODE_OF_CONDUCT.md

This code is based on the covenant code. He is only required to specify an email address to the community to send his messages. Now, this email is alderete.mauro@gmail.com.

License

/LICENSE

This license is a private personal license redacted by chatGPT. This is only an example. I recommend changing this license to other than to be attached better to your needs. You can replace it with any Open License offered by GitHub, too.

Tests

/.github/workflows/tests.yml

This workflow is the most complex to configure. This depends highly on your stack and environment. In some cases, you will probably need to split this workflow into unit and integration tests. It only contains some steps with a simple message showing you the commands to configure a node test environment.

I recommend you study your case carefully.

Versioning

/.github/workflows/versioning.yml

The versioning workflow contains the commands to generate a new release. This release could be attached with a binary file result from them of your project's build.

The file shows you a simple build step and package.

Project Automation

This template contains a Project Automation workflow to perform an issue status managment on project beta. For this workflows works correctly you need configure the secret GH_PROJECT_AUTOMATION with a PAT token in classic mode.

The PAT token must have permissions for:

• [x] repo
  • [x] repo:status
  • [x] repo_deployment
  • [x] public_repo
  • [x] repo:invite
  • [x] security_events
• [x] admin:org
  • [x] write:org
  • [x] read:org
  • [x] manage_runners:org
• [x] project
  • [x] read:project

Gitignore

/.gitignore

This file is empty. Replace the content with what you think is more convenient.

Others

The rest of the files usually don't require modifications. Implements defaults and typical workflows.