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

Get ready for publish on Hex.pm #17

Merged
merged 3 commits into from
Sep 11, 2024
Merged

Conversation

Annopaolo
Copy link
Collaborator

@Annopaolo Annopaolo commented Sep 4, 2024

Standard chores for releasing and publishing on Hex.
I suggest we do this before merging #15 (even though the PR is good and ready), as moving into Erlang distribution territory is quite a huge task.

Also, some administrative tasks are to be done in the context of this PR, such as making this repo public and deciding who will publish the library

@Annopaolo Annopaolo added the chore Maintenance chore label Sep 4, 2024
@noaccOS
Copy link
Contributor

noaccOS commented Sep 4, 2024

I'll proceed later with a full review, for now I'll just leave this here:

❯ nix run nixpkgs#reuse lint

# MISSING COPYRIGHT AND LICENSING INFORMATION

The following files have no copyright and licensing information:
* .check.exs
* .credo.exs
* .github/workflows/ci.yaml
* .tool-versions

Copy link
Contributor

@noaccOS noaccOS left a comment

Choose a reason for hiding this comment

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

Technically REUSE still doesn't pass because it wants the licenses under LICENSES.
Not sure if we want that (I'd say we do though?), but in case you can use reuse download --all to let it add them for you

mix.exs Outdated
Comment on lines 51 to 56
"""
A framework for handling distributed processing of data
over AMQP queues. Ordering guarantees are provided.
"""
Copy link
Contributor

Choose a reason for hiding this comment

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

I would personally not force a line break here

Suggested change
"""
A framework for handling distributed processing of data
over AMQP queues. Ordering guarantees are provided.
"""
"""
A framework for handling distributed processing of data \
over AMQP queues. Ordering guarantees are provided.
"""

Add relevant fields in mix.exs and pimp the README.md.

Signed-off-by: Arnaldo Cesco <[email protected]>
Signed-off-by: Arnaldo Cesco <[email protected]>
@Annopaolo Annopaolo force-pushed the publish-on-hex branch 2 times, most recently from 4b8947e to fb1d6a7 Compare September 4, 2024 14:04
Update copyright header everywhere and run
- `reuse init`
- `reuse downlad --all`

Signed-off-by: Arnaldo Cesco <[email protected]>
@Annopaolo Annopaolo marked this pull request as ready for review September 4, 2024 14:07
@Annopaolo Annopaolo requested review from rbino and bettio September 4, 2024 14:48
@bettio bettio merged commit b03e06c into secomind:main Sep 11, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Maintenance chore
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants