Added --remote option #191
Conversation
src/angular-cli-ghpages
Outdated
| @@ -24,6 +24,11 @@ commander | |||
| 'Provide the repository URL. If no value is provided, the `origin` remote of the current working directory is used.', | |||
| defaults.repo | |||
| ) | |||
| .option( | |||
| '-R, --remote <remote>', | |||
| 'Provide the remote name. If no value is provided, and --repo is not set, `origin` is used.', | |||
There was a problem hiding this comment.
| 'Provide the remote name. If no value is provided, and --repo is not set, `origin` is used.', | |
| 'Provide the remote name. If no value is provided `origin` is used.', |
There was a problem hiding this comment.
Line 145 of engine.ts prevents calling getRemoteUrl if options.repo is set.
There was a problem hiding this comment.
Yes, but even then the default would be origin. While reading this, my brain struggles to parse this sentence:
- If no value is provided --> so we provide nothing?!
- and --repo is not set --> AND nothing is set?!
originis used. ---> only, THEN then it'sorigin??
But it's always origin. 🤪
There was a problem hiding this comment.
I think I've understood the source of the confusion: there are two local repos that this software interacts with. If --repo isn't set, it reads the origin remote URL from the repo in the local directory (I'll refer to this as the installed repo), then it clones a repo, presumably in a temp directory. The latter I will refer to as the cloned repo.
I didn't intend to interact with the cloned repo's remote's name, but I now presume that I have. However, I believe it doesn't matter what remote name it uses, as long as it handles the deployment properly, so I think my code is okay there.
My intent was to have the --remote option change which remote URL is read from the installed repo, and I think my code does that.
There was a problem hiding this comment.
Wow, I had to read this three times. 😅 How can we make this understandable for a normal person? Maybe a documentation of your use case in the README.md?
There was a problem hiding this comment.
If you're having trouble with anything I write, I'm happy to rephrase it.
Most people have a git directory that they set up with
git remote add origin https://github.etc
They can use this package with
ng deploy
I have
git remote add github https://github.etc
I want to
ng deploy --remote github
There was a problem hiding this comment.
Has this helped any in understanding why --repo affects this?
Edited to add:
My documentation was copied from and is still nearly identical to the documentation for --repo:
If no value is provided, the `origin` remote of the current working directory is used.
There was a problem hiding this comment.
src/engine/engine.ts line 334 is where this software reads from the installed repo.
I have pushed an update to the --help messages to hopefully make them clearer.
There was a problem hiding this comment.
Excellent! I will craft a new release. 🙂🙏
src/deploy/schema.json
Outdated
| @@ -24,6 +24,10 @@ | |||
| "default": false, | |||
| "description": "Skip build process during deployment." | |||
| }, | |||
| "remote": { | |||
| "type": "string", | |||
| "description": "Provide the remote name. If no value is provided, and --repo is not set, `origin` is used." | |||
There was a problem hiding this comment.
| "description": "Provide the remote name. If no value is provided, and --repo is not set, `origin` is used." | |
| "description": "Provide the remote name. If no value is provided `origin` is used." |
|
Just a little question: shouldn't it be release as 2.1.0 since it's a new feature aka minor release? |
|
Hmmm... Yes! 😅 |
|
I use |
|
Thank you for the details. This will help me to ensure that your use case is sufficiently covered! FYI @fmalcher |
I don't use
originas my primary remote and I didn't want to use the--repooption every time, so I added a--remoteoption.