consul/grecia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update configuration instructions

Browse Source
This commit is contained in:
taitus
2024-08-12 14:33:10 +02:00
parent 6f692abdf8
commit e858e226cd
2 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/en/getting_started/configuration.md
View File

@@ -1,17 +1,17 @@
# Configure your fork # Configure your fork
## Travis CI ## Continuous Integration with GitHub Actions
[Travis](https://travis-ci.org/) is a Continuous Integration service, free for OpenSource projects (like Consul Democracy and its forks). It will help you check on each Pull Request if the test suite is alright. [GitHub Actions](https://docs.github.com/en/actions) is a tool integrated into GitHub that allows you to automate tasks such as running tests every time you make a change to your code. Since Consul Democracy already includes predefined configurations for GitHub Actions, enabling continuous integration in your fork is very straightforward.
1. Visit <https://github.com/marketplace/travis-ci> and click the "**Install it for free**" green button at the bottom of the page. ### Steps to enable GitHub Actions
2. Click on the "**Complete order and begin installation**" green button. 1. **Enable GitHub Actions in your fork**:
1. Once you have created the fork, go to the "**Actions**" tab in your GitHub repository.
1. You will see a message that says: "Workflows aren’t being run on this forked repository." This is normal because GitHub disables workflows by default in newly forked repositories for security reasons.
1. Click the "**I understand my workflows, go ahead and enable them**" button to enable workflows in your fork.
3. If you are asked to Authorize Travis CI to access your Github account, check the organization or user where you have your Consul Democracy fork at the bottom and click the "**Authorize travis-ci**" button. 2. **Verify the configuration**:
1. Make a change to any project file (for example, edit a `.md` file) in a branch other than master and push it to your fork.
4. Visit your [Travis profile](https://travis-ci.org/profile/) and enable Travis for your Consul Democracy fork in the list of repositories. 1. Open a pull request from the new branch to master in your fork.
1. Go to the "**Actions**" tab and verify that the tests are running correctly based on the workflows defined in the project's `.github/workflows/` directory.
5. Click on the sprocket icon to the right of the repository to see the builds.
6. Check that everything is well configured by creating a test Pull Request (editing a simple .md file could help).

22
docs/es/getting_started/configuration.md
View File

@@ -1,17 +1,17 @@
# Configura tu fork # Configura tu fork
## Travis CI ## Integración Continua con GitHub Actions
[Travis](https://travis-ci.org/) es un servicio de Integración Contínua, gratuito para proyectos OpenSource (como Consul Democracy y sus forks). Te ayudará a vigilar que en las Pull Requests no se rompan los tests. [GitHub Actions](https://docs.github.com/es/actions) es una herramienta integrada en GitHub que permite automatizar tareas como la ejecución de tests cada vez que haces un cambio en tu código. Dado que Consul Democracy ya incluye configuraciones predefinidas para GitHub Actions, habilitar la integración continua en tu fork es muy sencillo.
1. Visita <https://github.com/marketplace/travis-ci> y haz click en el botón verde "**Install it for free**"" al pie de la página. ### Pasos para habilitar GitHub Actions
2. Haz click en el botón verde "**Complete order and begin installation**" 1. **Habilita GitHub Actions en tu fork**:
1. Una vez que hayas creado el fork, ve a la pestaña "**Actions**" en tu repositorio en GitHub.
1. Verás un mensaje que dice: "Workflows aren’t being run on this forked repository". Esto es normal, ya que GitHub deshabilita por defecto los workflows en los nuevos forks por motivos de seguridad.
1. Haz clic en el botón "**I understand my workflows, go ahead and enable them**" para habilitar los workflows en tu fork.
3. Si se te solicita acceso a tu cuenta de Github por parte de Travis CIaccess, marca la organización o usuario bajo el cual reside tu fork de Consul Democracy y haz click en el botón "**Authorize travis-ci**". 2. **Verifica la configuración**:
1. Realiza un cambio en algún archivo del proyecto (por ejemplo, edita un archivo `.md`) en una rama distinta de master y súbelo a tu fork.
4. Visita [tu perfil en Travis](https://travis-ci.org/profile/) y habilita Travis para tu fork de Consul Democracy en el listado de repositorios. 1. Abre una pull request desde nueva rama hacia master en tu fork.
1. Ve a la pestaña "**Actions**" y verifica que los tests se están ejecutando correctamente en base a los workflows definidos en la carpeta `.github/workflows/` del proyecto.
5. Haz click en el icono de un piñón a la derecha del repositorio para ver las builds.
6. Comprueba que todo está bien configurado creando un Pull Request de prueba (editar un simple fichero .md podría servir).