Skip to content

Commit

Permalink
docs(Gubbins): add CI/CD to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Loxeris committed Aug 29, 2024
1 parent e8eb6a5 commit e7853e7
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions packages/extensions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,13 +179,21 @@ In this example, the new App list is defined in a [separate file](src/gubbins/ap

Feel free to explore and adjust the code to fit your requirements.

## Continuous integration

Continuous integration helps to make sure the application still works correctly after every change pushed to the repository.

You can find a GitHub workflow example at [`.github/workflows/extension.yml`](/.github/workflows/extension.yml).

## Deployment

Deployment of the extension can be done using the Dockerfile provided in the repository. The Dockerfile builds the Next.js application and serves it using a nginx server.

See [Docker's Documentation](https://docs.docker.com/get-started/) for more information on how to deploy your application using Docker.
It can be automatically deployed using CI/CD tools like GitHub Actions, GitLab CI/CD, or Jenkins.

You can find an example of deployment using GitHub Actions with the job `build-deploy-gubbins-image` in [`.github/workflows/deployment.yml`](/.github/workflows/deployment.yml).

## Good Practices

- **Code Quality**: Ensure your code is clean, well-documented, and follows best practices. Use tools like [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) to maintain code quality.
Expand Down

0 comments on commit e7853e7

Please sign in to comment.