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

Consider changing name of this repo #15

Closed
jdhoffa opened this issue Jan 25, 2024 · 18 comments
Closed

Consider changing name of this repo #15

jdhoffa opened this issue Jan 25, 2024 · 18 comments
Labels
feature a feature request or enhancement

Comments

@jdhoffa
Copy link
Member

jdhoffa commented Jan 25, 2024

Directories that end with .template are interpreted as a file extension on Mac, with the Pages template file type.

This is a bit of a pain, and may be worth nipping in the bud.

@jdhoffa jdhoffa added enhancement feature a feature request or enhancement and removed enhancement labels Jan 25, 2024
@AlexAxthelm
Copy link
Contributor

pacta.template.pkgdown?

@cjyetman
Copy link
Member

Originally I modeled this after https://github.com/tidyverse/tidytemplate/ and https://github.com/ropensci-org/rotemplate. Either I added the "." to stick with our pacta repos naming scheme, or they changed those names later. I think pacta.pkgdowntemplate might be logical?

@jdhoffa
Copy link
Member Author

jdhoffa commented Jan 29, 2024

Since this repo is actively used in workflows to generate several pkgdown websites, may I suggest the following next steps:

  • Archive (not delete) this repo
  • Fork repo with new name suggested by @cjyetman
  • Open PRs to all relevant repos pointing to new template repo
  • Transfer issues

I think all the relevant people are already on this thread, do you both agree with that strategy?

@cjyetman
Copy link
Member

I think you can just rename this repo and then open the PRs in the other repos to point to the new name, no?

@jdhoffa
Copy link
Member Author

jdhoffa commented Jan 29, 2024

Either works.

  • The fork strategy means there's no downtime (or, if we somehow miss updating a repo to point to it, the repo will still generate a website based on the old template)
  • The simpler strategy means we may break things

@cjyetman
Copy link
Member

ah, now I get why you suggested that... up to you

@AlexAxthelm
Copy link
Contributor

I vote for rename. Unless we open a new repo with the old name, everything should work as normal:

In addition to redirecting web traffic, all git clone, git fetch, or git push operations targeting the previous location will continue to function as if made on the new location. However, to reduce confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using git remote on the command line:

https://docs.github.com/en/repositories/creating-and-managing-repositories/renaming-a-repository

@jdhoffa
Copy link
Member Author

jdhoffa commented Jan 31, 2024

I followed the tidytemplate style for the repository name.

I will leave this issue open for now until all repositories that use this workflow have updated their pkgdown workflows.

jdhoffa added a commit to RMI-PACTA/pacta.data.scraping that referenced this issue Jan 31, 2024
jdhoffa added a commit to RMI-PACTA/pactaverse that referenced this issue Jan 31, 2024
jdhoffa added a commit that referenced this issue Jan 31, 2024
cjyetman added a commit to RMI-PACTA/pacta.portfolio.utils that referenced this issue Jan 31, 2024
cjyetman added a commit to RMI-PACTA/pacta.portfolio.import that referenced this issue Jan 31, 2024
cjyetman added a commit to RMI-PACTA/pacta.portfolio.audit that referenced this issue Jan 31, 2024
@jdhoffa
Copy link
Member Author

jdhoffa commented Jan 31, 2024

AFAIK @cjyetman and myself are the only ones that make use of this pkgdown template but just in case:
FYI @RMI-PACTA/developers

@AlexAxthelm
Copy link
Contributor

See current status of migrating to new name: https://github.com/search?q=org%3ARMI-PACTA%20rmi-pacta%2Fpacta.pkgdown.template&type=code

@cjyetman
Copy link
Member

hmmmm.... I thought we would also have to update our DESCRIPTION files, but I'm getting errors on my PRs

Caused by error:
! Could not solve package dependencies:

  • deps::.: Can't install dependency rmi-pacta/pacta.pkgdown.rmitemplate
  • local::.: Can't install dependency rmi-pacta/pacta.pkgdown.rmitemplate

@jdhoffa
Copy link
Member Author

jdhoffa commented Jan 31, 2024

I'll look into it. Guess this morning is a pkgdown morning :D

@cjyetman
Copy link
Member

maybe GitHub just needs some time to properly propagate the new name

@jdhoffa
Copy link
Member Author

jdhoffa commented Jan 31, 2024

Yeah let's give it a little bit, and if we're still having trouble this afternoon we can look into it?

Off the top of my head, I'm not sure what else would have to change.

@cjyetman
Copy link
Member

"break now, fix later" 🤣

@jdhoffa
Copy link
Member Author

jdhoffa commented Jan 31, 2024

"break now, fix later" 🤣

I mean, I opted for the safer approach!

You both voted for the faster/ more dangerous one 😂 the tables seem to have turned since I was away

jdhoffa added a commit that referenced this issue Jan 31, 2024
* Update _pkgdown.yml

Relates to #15

* update all pkgdown.template refs
cjyetman added a commit to RMI-PACTA/pacta.data.validation that referenced this issue Jan 31, 2024
cjyetman added a commit to RMI-PACTA/pacta.portfolio.utils that referenced this issue Jan 31, 2024
cjyetman added a commit to RMI-PACTA/pacta.portfolio.audit that referenced this issue Jan 31, 2024
cjyetman added a commit to RMI-PACTA/pacta.portfolio.allocate that referenced this issue Jan 31, 2024
cjyetman added a commit to RMI-PACTA/pacta.portfolio.import that referenced this issue Jan 31, 2024
@jdhoffa
Copy link
Member Author

jdhoffa commented Feb 2, 2024

jdhoffa added a commit to RMI-PACTA/pactaverse that referenced this issue Feb 2, 2024
* Update _pkgdown.yml

Relates to RMI-PACTA/pacta.pkgdown.rmitemplate#15

* Update DESCRIPTION
jdhoffa added a commit to RMI-PACTA/pacta.data.scraping that referenced this issue Feb 2, 2024
* Update _pkgdown.yml

Relates to RMI-PACTA/pacta.pkgdown.rmitemplate#15

* update DESCRIPTION
@jdhoffa
Copy link
Member Author

jdhoffa commented Feb 2, 2024

Done!
Closing this comment

@jdhoffa jdhoffa closed this as completed Feb 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement
Projects
None yet
Development

No branches or pull requests

3 participants