Hello @wyardley A new version of the Slack Orb has been published. Reviewing PRs may take some time for the next month during the Hacktoberfest event. There are a lot of participants and just a few of us, but we will get to all submissions in a timely fashion.
In the future all PR’s will result in automatically releasing new Orb versions but that pipeline design is still a work in progress.
There is no automatic generating of the Readme files for orbs by default. Orbs documentation is automatically generated on the Orb registry page for that orb.
I’m aware of the autogenerated docs on the registry.
Readme files in the orb’s code repository should ideally contain information to help contributors begin to collaborate on the orb.
That would make more sense; currently, though, the checklist requests that all parameters be documented in the README as well, which, from what I can see, seems to result in some drift. So maybe it would make sense to either figure out a way to generate the markdown docs as well, or else pull out the user docs from the README and just provide instructions for contributing and a link to the generated docs?
Would you mind providing a link to this checklist? We may have some older documentation floating around but at the moment I do not believe we have any live suggestions for readme files. Orb author best practices can be found here: https://circleci.com/docs/2.0/orbs-best-practices
We’ll take a look at the checklist and either update, remove, or integrate it into this best practice page.
when do new releases get cut? i was about to make a PR to add the channel override setting but I see it was already added and merged a few days ago. Is it a manual trigger to make a new version? Can someone push that button please?
I get an error when I try to set the channel: variable on the approval-notification job in 3.4.0. I was hoping 3.5.0 would’ve been released before the weekend but I’ll look for it again on monday at this point.