Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: archive older webrtc repos #80

Merged
merged 3 commits into from Nov 23, 2022
Merged

chore: archive older webrtc repos #80

merged 3 commits into from Nov 23, 2022

Conversation

p-shahi
Copy link
Member

@p-shahi p-shahi commented Nov 22, 2022

Summary

Archives https://github.com/libp2p/js-libp2p-webrtc-direct, https://github.com/libp2p/js-libp2p-webrtc-star, and https://github.com/libp2p/js-libp2p-webrtc-peer
Complementary to #74
Addresses libp2p/js-libp2p#385

Why do you need this?

We no longer maintain these repos as they are being deprecated in favor of solutions based on https://github.com/libp2p/specs/tree/master/webrtc (libp2p/js-libp2p-webrtc#4) and libp2p/specs#475

What else do we need to know?

Todo:

  • update README.md in each repo before merging this PR

DRI: myself

Reviewer's Checklist

  • It is clear where the request is coming from (if unsure, ask)
  • All the automated checks passed
  • The YAML changes reflect the summary of the request
  • The Terraform plan posted as a comment reflects the summary of the request

@p-shahi p-shahi requested review from a team as code owners November 22, 2022 15:39
@github-actions
Copy link
Contributor

Before merge, verify that all the following plans are correct. They will be applied as-is after the merge.

Terraform plans

libp2p

Terraform used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
  ~ update in-place

Terraform will perform the following actions:

  # github_repository.this["js-libp2p-webrtc-direct"] will be updated in-place
  ~ resource "github_repository" "this" {
      ~ archived               = false -> true
        id                     = "js-libp2p-webrtc-direct"
        name                   = "js-libp2p-webrtc-direct"
        # (28 unchanged attributes hidden)

        # (1 unchanged block hidden)
    }

  # github_repository.this["js-libp2p-webrtc-peer"] will be updated in-place
  ~ resource "github_repository" "this" {
      ~ archived               = false -> true
        id                     = "js-libp2p-webrtc-peer"
        name                   = "js-libp2p-webrtc-peer"
        # (27 unchanged attributes hidden)
    }

  # github_repository.this["js-libp2p-webrtc-star"] will be updated in-place
  ~ resource "github_repository" "this" {
      ~ archived               = false -> true
        id                     = "js-libp2p-webrtc-star"
        name                   = "js-libp2p-webrtc-star"
        # (28 unchanged attributes hidden)

        # (1 unchanged block hidden)
    }

Plan: 0 to add, 3 to change, 0 to destroy.

Copy link
Contributor

@BigLep BigLep left a comment

Choose a reason for hiding this comment

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

Thanks for handling (and for having the item about updating READMEs).

@galargh
Copy link
Contributor

galargh commented Nov 22, 2022

Thanks for handling (and for having the item about updating READMEs).

We should integrate it in GitHub Management - auto-generating deprecation README.md header when a repository is getting archived.

@p-shahi p-shahi merged commit a4dfd57 into master Nov 23, 2022
@p-shahi p-shahi deleted the archive-webrtc-repos branch November 23, 2022 01:58
@BigLep
Copy link
Contributor

BigLep commented Nov 23, 2022

Thanks for handling (and for having the item about updating READMEs).

We should integrate it in GitHub Management - auto-generating deprecation README.md header when a repository is getting archived.

@galargh : Totally agreed this would be ideal. There's a tracking issue for this right (although I'm not seeing one in https://github.com/protocol/github-mgmt-template/issues )? I'm happy to leave some comments there.

I think part of the reason folks haven't done more archiving historically is because of the steps involved or hitting the decision tree on how to archive.

What's not clear to me is how much versatility we need in the archival message we want to inject at the top of the readme. I guess we can have YAML flags for things like:

Generate README banner: true
README banner text: str

or maybe also provide more guiding options that can then be used to generate the README notice.

Reason: 
Replacement(s): 
Where to ask questions: 
etc.

That said, I don't think we'd want to be in the business of keeping the README notice text and github-mgmt in sync if there are further changes made to the README.

@galargh
Copy link
Contributor

galargh commented Nov 24, 2022

Thanks for the context. I created a tracking issue in ipdxco/github-as-code#83

That said, I don't think we'd want to be in the business of keeping the README notice text and github-mgmt in sync if there are further changes made to the README.

Actually, we should be either removing archived repos from GitHub Management altogether or stopping tracking anything but the archived status. That's because we cannot modify anything on archived repos.

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.

None yet

3 participants