Skip to content
This repository was archived by the owner on Jan 16, 2020. It is now read-only.

Added script to synchronize repositories with zf-component-list.json#22

Merged
weierophinney merged 1 commit into
zendframework:masterfrom
michalbundyra:sync-repos
Nov 7, 2017
Merged

Added script to synchronize repositories with zf-component-list.json#22
weierophinney merged 1 commit into
zendframework:masterfrom
michalbundyra:sync-repos

Conversation

@michalbundyra
Copy link
Copy Markdown
Member

It synchronizes only repositories listed in file
https://docs.zendframework.com/zf-mkdoc-theme/scripts/zf-component-list.json

It updates description, homepage (link to docs), disable wiki and projects tabs.

Usage:

$ php bin/sync-repos.php <github-token>

To generate github token please see: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token

It synchronizes only repositories listed in file
https://docs.zendframework.com/zf-mkdoc-theme/scripts/zf-component-list.json

It updates description, homepage (link to docs), disable wiki and projects tabs.
@froschdesign
Copy link
Copy Markdown
Member

@webimpress
Nice idea! 👍

It would be great, if we can synchronize all descriptions:

  • GitHub repository description
  • the description in the composer.json
  • the description in the readme file
  • the "site description" in the MkDocs config file (mkdocs.yml)

@michalbundyra
Copy link
Copy Markdown
Member Author

@froschdesign Totally agree that we should synchronize descriptions everywhere. Not sure if we can do it in README.md because the short description is not always specified there.
Maybe it should be another script to update descriptions in repository files, because it needs create branch and PRs. I'll think about it. In that case we can also update a bit more composer.json to make it consistent across all repositories. Or maybe go even crazier and update also other files .... like license, .gitattributes, .... ?

Purpose of this PR was to change method of generating component list in zf3-web. See zendframework/zf3-web#89

Comment thread bin/sync-repos.php
'name' => $name,
'description' => $comp['description'],
'homepage' => $comp['url'],
'has_projects' => false,
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.

Why are you setting this to false? We've used these on several components, particularly when coordinating a new major version... I'd prefer this to be true or unaltered.

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.

I'll take care of this on merge.

@weierophinney weierophinney merged commit a0226b3 into zendframework:master Nov 7, 2017
weierophinney added a commit that referenced this pull request Nov 7, 2017
Added script to synchronize repositories with zf-component-list.json
weierophinney added a commit that referenced this pull request Nov 7, 2017
@michalbundyra michalbundyra deleted the sync-repos branch November 7, 2017 22:16
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants