Skip to content

Include available versions for all the packs in the index - #72

Merged
Kami merged 8 commits into
masterfrom
include_pack_tags
Sep 10, 2019
Merged

Include available versions for all the packs in the index#72
Kami merged 8 commits into
masterfrom
include_pack_tags

Conversation

@Kami

@Kami Kami commented Sep 10, 2019

Copy link
Copy Markdown
Contributor

This pull request updates generate index script so we now also include all the available versions for each pack in the index.json file.

Implementation

This implementation utilizes Github API to retrieve all the available tags for a particular pack repo.

TODO

  • Handle Github authentication so we get a higher rate limit

Kami added a commit to StackStorm-Exchange/stackstorm-slack that referenced this pull request Sep 10, 2019
@Kami

Kami commented Sep 10, 2019

Copy link
Copy Markdown
Contributor Author

I updated the script so we use Github credentials we generate for each pack repo.

I first thought we might have API rate limiting issues, but we use different Github credentials for each pack deployment so we should be fine.

The whole process is still a bit inefficient since I followed the existing approach which means we rebuild the whole index on each pack deployment. I will file this under "feature improvement / optimization" :)

I also confirmed it's working at StackStorm-Exchange/stackstorm-slack#52 (https://circleci.com/gh/StackStorm-Exchange/stackstorm-slack/255, StackStorm-Exchange/index@16d6c1d).

@Kami Kami changed the title [WIP] Include available tags for all the packs in the index Include available tags for all the packs in the index Sep 10, 2019

@arm4b arm4b left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

tags in context of Exchange index and as a property of the pack could have a little bit generic meaning.
If the goal here to list all available released versions, maybe versions or releases would be a better naming?

Additionally, the PR doesn't make it clear which functionality relies on a list of available pack versions in the exchange index.

@Kami

Kami commented Sep 10, 2019

Copy link
Copy Markdown
Contributor Author

@armab I agree, versions / available_versions is a better name for that attribute (and it's also consistent with the existing version attribute).

At this point no functionality relies on this attribute yet, but there are various use cases for it (e.g. right now listing available pack versions in StackStorm CLI depends on git, etc.).

@Kami

Kami commented Sep 10, 2019

Copy link
Copy Markdown
Contributor Author

@armab Here we go - 8b86314 (StackStorm-Exchange/index@1a165bd).

@arm4b arm4b left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@Kami Kami changed the title Include available tags for all the packs in the index Include available versions for all the packs in the index Sep 10, 2019
blag
blag previously requested changes Sep 10, 2019
Comment thread .circle/index.py
Comment thread .circle/index.py
Comment thread .circle/index.py Outdated
Co-Authored-By: Drew H <blag@users.noreply.github.com>
@Kami
Kami merged commit 437688f into master Sep 10, 2019
@Kami
Kami deleted the include_pack_tags branch September 10, 2019 20:56
@Kami Kami mentioned this pull request Sep 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants