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

Admin improvements #32

Open
jeffwack111 opened this issue Nov 26, 2024 · 15 comments
Open

Admin improvements #32

jeffwack111 opened this issue Nov 26, 2024 · 15 comments

Comments

@jeffwack111
Copy link
Owner

  1. Register this publicly
  2. use Documenter.jl to create documentation
  3. set up CI testing with GitHub actions
@jeffwack111
Copy link
Owner Author

What I have done so far:

  • Used PkgTemplates.jl to set up my workspace
  • this includes a Github actions file which currently runs no tests but does successfully build the package

I have not publicly registered the package yet

@jeffwack111
Copy link
Owner Author

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Error while trying to register: "Pre-release version not allowed"

@jeffwack111
Copy link
Owner Author

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Error while trying to register: "Pre-release version not allowed"

@jeffwack111
Copy link
Owner Author

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Error while trying to register: "Pre-release version not allowed"

@jeffwack111
Copy link
Owner Author

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Registration pull request created: JuliaRegistries/General/120310

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 4c9211aecb6712acb3f3b6a74e465eec38f14fc4
git push origin v0.1.0

@jeffwack111
Copy link
Owner Author

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Registration pull request updated: JuliaRegistries/General/120310

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 20e4dbd97d0bc01f043d80bc7c9b40b20c32eef7
git push origin v0.1.0

@jeffwack111
Copy link
Owner Author

Sadly I cannot use the name Spiders...maybe it will become HyperbolicComponents? Not loving it

@jeffwack111
Copy link
Owner Author

I should really make documentation before registering, but I should also stabilize the API in order to not constantly need to update the documentation. Are modules supposed to help with this? Still no modules in this pile of code

@jeffwack111
Copy link
Owner Author

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Registration pull request created: JuliaRegistries/General/120964

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" bef08dc35f8fc72a640ec48d828560fc86c309b7
git push origin v0.1.0

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

No branches or pull requests

2 participants