Initial improvement for Archivista contributors #114
Merged
Conversation
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
This commit changes `compose.psql.yml` to `compose-psql.yml` as the double extension can be confusing for some tools. Signed-off-by: Kairo de Araujo <[email protected]>
kairoaraujo
force-pushed
the
include_makefile_contributing
branch
2 times, most recently
from
1a21cbb
to
35eb0e4
Compare
This commit simplifies the development routing using containers and shortcuts using Makefile. The user can start the development environment using the command `make run-dev` command, which will create and start all the containers required for Archivista. The significant advantage is that the user wants to test the container, so it is not necessary to build Archivista, rebuild the container, and run it. It is done automatically by CompileDaemon. This command also includes: `make stop` to stop all container `make clean` to clean all Archivista containers Added a shortcut to run the Archivista tests `make tests` This strategy is inspired by - Warehouse development: https://warehouse.pypa.io/development/getting-started.html#running-the-warehouse-container-and-services - RSTUF development: https://github.com/repository-service-tuf/repository-service-tuf-api#running-api-development Signed-off-by: Kairo de Araujo <[email protected]>
This commit includes the CONTRIBUTING.md seed. The initial content shares how to start contributing, the requirements, and how to quick-start the development environment. Signed-off-by: Kairo de Araujo <[email protected]>
kairoaraujo
force-pushed
the
include_makefile_contributing
branch
from
35eb0e4
to
7e750ca
Compare
|
I rebased to update the Dockerfile-dev with the latest Golang base image hash. |
mikhailswift
previously approved these changes
Dec 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR includes a Makefile and the contributors with a "feature" for new contributors.
First, add a small refactoring that changes. changes
compose.psql.ymltocompose-psql.ymlas thedouble extension can be confusing for some tools.
Then simplifies the development routing using containers and shortcuts using
Makefile.The user can start the development environment using the command
make run-devcommand to create and start all thecontainers required for Archivista. The significant advantage is that the user wants to test the container, so it is not necessary to build Archivista, rebuild the container and run it. It is done automatically by CompileDaemon.
This command also includes:
make stopto stop all containermake cleanto clean all Archivista containersAdded a shortcut to run the Archivista tests
make testsThis strategy is inspired by
It also includes the
CONTRIBUTING.mdseed.The initial content shares how to start contributing, the requirements, and how to quick-start the development environment.
Related #105
Closes #106
Closes #107