Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contribution docs #36

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Contribution docs #36

wants to merge 11 commits into from

Conversation

stephanieatte
Copy link

@stephanieatte stephanieatte commented Oct 24, 2024

This PR adds some key sections and documents that have been omitted. It allows users to run tests with docker and make test without docker compose

  • Add the Contribution Section back to the repo
  • Remove the docker-compose.yml file back to the repo
  • Add Updated Dockerfile to the root folder
  • Updated Makefile

Added contribution docs
Added docker-compose.yml
@stephanieatte stephanieatte requested a review from a team as a code owner October 24, 2024 19:00
@stephanieatte stephanieatte requested review from jeremybumsted and removed request for a team October 24, 2024 19:02
Copy link

@jeremybumsted jeremybumsted left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Testing this locally, make test from the contribution docs and docker compose run --rm plugin_test seem to fail with bats issues.

bats_load_safe: Could not find '/usr/local/lib/bats/load.bash'[.bash]

@stephanieatte Not sure if anything needs to be updated there or if it's a me issue? Have you run the tests locally to make sure everything works?

Comment on lines 1 to 12
---
version: '3'
services:
plugin_test:
build:
context: .
dockerfile: ./tests/Dockerfile
plugin_lint:
image: buildkite/plugin-linter:latest
command: ['--id', 'monebag/monorepo-diff']
volumes:
- ".:/plugin"
Copy link

@pzeballos pzeballos Oct 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was removed because it's unused and it's referencing monebag, so it won't work

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stephanieatte
Copy link
Author

Will check on the contribution docs to make sure it works just like it should

@stephanieatte
Copy link
Author

stephanieatte commented Nov 7, 2024

make test

or

make build-docker-test && make test-docker

The lint test fails on the build checking this out right now

@stephanieatte
Copy link
Author

@jeremybumsted @pzeballos i have made the changes please can you confirm that it works on your end

Dockerfile Outdated Show resolved Hide resolved
Copy link

@jeremybumsted jeremybumsted left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stephanieatte awesome stuff

I think we're still needing to change some things in the actual CONTRIBUTING doc as we reference GitHub actions when it's now all done via the plugin pipeline, and the entire testing section will probably need an update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants