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

[#57] Add more details to README.md #58

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

alanking
Copy link
Contributor

  • Add a note about Docker Image tags in the instructions for building
    the builders

  • Add more details about directory structures and naming schemes as it
    relates to the build and test hooks for iRODS plugins as these use a
    specific system for package discovery and installation

- Add a note about Docker Image tags in the instructions for building
the builders

- Add more details about directory structures and naming schemes as it
relates to the build and test hooks for iRODS plugins as these use a
specific system for package discovery and installation
```
NOTE: `/path/to/built_irods_packages` should point to the directory containing the different directories for packages of the various platforms AND the symlinks to said directories, if you have been following the pattern described above.

Another thing to keep in mind: the test hook for iRODS plugins also uses the same directory naming scheme when attempting to discover built plugin packages for testing. You may wish to consider using a directory structure similar to the built iRODS packages as described above for the output directory of your built plugin packages so that the built and test hooks can work in tandem.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

built and test hooks -> build and test hooks

```
NOTE: `/path/to/built_irods_packages` should point to the directory containing the different directories for packages of the various platforms AND the symlinks to said directories, if you have been following the pattern described above.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Make this extraneously clear, spell out everything here, as well.

docker build -f plugin_builder.centos7.Dockerfile -t irods-plugin-builder:centos-7 .
docker build -f plugin_builder.ubuntu16.Dockerfile -t irods-plugin-builder-42s:ubuntu-16.04 .
docker build -f plugin_builder.ubuntu18.Dockerfile -t irods-plugin-builder-42s:ubuntu-18.04 .
docker build -f plugin_builder.centos7.Dockerfile -t irods-plugin-builder-42s:centos-7 .
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I only included these platforms because irods_python_ci_utilities only supports these platforms at this time.

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

Successfully merging this pull request may close these issues.

1 participant