Request to publish Slack orb

Ecosystem Orbs
1

Can someone publish the latest changes for https://github.com/CircleCI-Public/slack-orb/commits/staging ?

Also, if someone from Circle wouldn’t mind reviewing https://github.com/CircleCI-Public/slack-orb/pull/104, that would be great.

Seems like there’s no support for autogenerating the README? Or is there and I just don’t know how?

2

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.

You can find the current documentation for the Slack Orb here: https://circleci.com/orbs/registry/orb/circleci/slack

Readme files in the orb’s code repository should ideally contain information to help contributors begin to collaborate on the orb.

3

Thanks for the CRs and the release.

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?

4

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.

5

I’m looking at the checklist in the PR template:

Also, there had been a lot of PRs recently to tidy up docs related to usage of the orb.

Maybe I misunderstood the intent of items 1 and 2, but given that the parameters were documented in the README, I guess I assumed that we were being requested to update them there.

If someone removed all the redundant docs from the README and included a link to the generated docs, I’d agree that the template above would work fine.

6

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?

7

@brett-picwell: They actually did release the channels fix I think, just hasn’t been merged from staging => master, but should exist in 2.4.0.

8

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.

1 Like
9

Oh yeah, on approval-notification, the person who added that feature didn’t add it.

I PRed adding that later, so that one is not yet released.

10

@KyleTryon any chance we can get this released today?

1 Like
11

any chance of a deploy/new version this week? it’s not blocking me but i’d like to finish this feature for my team.

12

Hello @brett-picwell

Sorry for the delay, with Hacktoberfest this month we are at limited capacity across all of the incoming updates. The Slack orb is meant to be on an automated release that may not be functioning properly at the moment (it is one of our first orbs). I’d like to investigate this and manually push the update for you all. Would you mind linking to the PR/Feature you were looking to have added so I can trace back the issue with our release process? Thank you.

13

@KyleTryon: I think


is what he needs (what I need too, obviously :wink:)

14

yes, this is it exactly. https://github.com/CircleCI-Public/slack-orb/pull/108 (just to add the pr link directly)

15

Hello,

Thank you for your patience. Version circleci/slack@3.4.1 has been released. There will need to be additional changes made to the development pipeline as I believe this release should have resulted in a minor change, not a patch. I do not believe anyone should be negatively affected but please feel free to share any and all feedback.

release pipeline for anyone curious: https://circleci.com/gh/CircleCI-Public/slack-orb/1276