search

JuliaLogging / ProgressLogging.jl

MIT License
50 stars 8 forks source link

Release #1

Closed tkf closed 4 years ago

tkf commented 5 years ago

Continuing discussion from: https://github.com/JunoLab/Juno.jl/issues/400

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

pfitzseb commented 5 years ago

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 commented 5 years ago

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 commented 5 years ago

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 commented 5 years ago

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

tkf commented 5 years ago

The last concern for me is what to do with @logprogress API https://github.com/JunoLab/ProgressLogging.jl/issues/7#issuecomment-544660163

tkf commented 5 years ago

How about releasing after #11?

tkf commented 4 years ago

@JuliaRegistrator register

@pfitzseb Thanks for reviewing #11!

pfitzseb commented 4 years ago

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

@JuliaRegistrator register

JuliaRegistrator commented 4 years ago

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