Release

[tkf]

Continuing discussion from: JunoLab/Juno.jl#400

@pfitzseb Is there something you want to do before registering it?

• Is name OK? I just realized that the name crashes with @adamslc's ProgressLogging.jl although it's not registered.
• Is API OK? I have some suggestions but since this API is already out in the wild, I think releasing it as-is first makes sense.
• Enable Documenter (see also Fix Travis setup for PR #3)
• Write README Add a short description in README #4

[pfitzseb]

Is name OK? I just realized that the name crashes with @adamslc's ProgressLogging.jl although it's not registered.

IMHO the name is fine (ProgressBase.jl could work too, but seems less descriptive).

Is API OK? I have some suggestions but since this API is already out in the wild, I think releasing it as-is first makes sense.

Agreed. Let's get this out in the current form and iterate over the API afterwards (ideally with deprecation warnings).

Would be good to have a minimal readme before registering, but apart from that this should be good to go.

[tkf]

ProgressBase.jl could work too, but seems less descriptive

I thought about this too, but ProgressBase.jl sounds like a low-level package for package authors. This package is likely to be used by end-users (e.g., in some scripts). So I wanted something else.

Would be good to have a minimal readme before registering

Good point. Will do.

This reminds me that it's also better to set up Documenter. Can you do this? I don't have access to the ⛭ Settings tab.

[pfitzseb]

I thought about this too, but ProgressBase.jl sounds like a low-level package for package authors.

I'd like to think of this package as something package authors use. I know @ChrisRackauckas has been using Juno.@progress for a while. But yeah, let's just keep the current name.

This reminds me that it's also better to set up Documenter. Can you do this? I don't have access to the ⛭ Settings tab.

Sure, will do.

[pfitzseb]

Alright, anything else we want to change before the first release?

[tkf]

The last concern for me is what to do with @logprogress API #7 (comment)

[tkf]

How about releasing after #11?

[tkf]

@JuliaRegistrator register

@pfitzseb Thanks for reviewing #11!

[pfitzseb]

Turns out JuliaRegistrator wasn't installed on the repo, so

@JuliaRegistrator register

[JuliaRegistrator]

Registration pull request created: JuliaRegistries/General/5110

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 Julia TagBot is installed, or can be done manually through the github interface, or via:

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