Adds support docs to the top of the readme etc

This commit is contained in:
James Ives 2020-07-04 14:29:45 -04:00
parent 57a287935d
commit 2546145f69
2 changed files with 11 additions and 1 deletions

View File

@ -27,6 +27,7 @@ export async function init(action: ActionInterface): Promise<void | Error> {
action.workspace, action.workspace,
action.silent action.silent
) )
await execute(`git remote rm origin`, action.workspace, action.silent) await execute(`git remote rm origin`, action.workspace, action.silent)
await execute( await execute(
`git remote add origin ${action.repositoryPath}`, `git remote add origin ${action.repositoryPath}`,
@ -42,7 +43,7 @@ export async function init(action: ActionInterface): Promise<void | Error> {
info('Git configured… 🔧') info('Git configured… 🔧')
} catch (error) { } catch (error) {
throw new Error( throw new Error(
`There was an error initializing the repository: ${suppressSensitiveInformation( `There was an error initializing the repository,: ${suppressSensitiveInformation(
error.message, error.message,
action action
)} ` )} `

View File

@ -13,6 +13,15 @@ export default async function run(
let status: Status = Status.RUNNING let status: Status = Status.RUNNING
try { try {
info(`GitHub Pages Deploy Action 🚀
Getting Started Guide: https://github.com/marketplace/actions/deploy-to-github-pages
FAQ: https://github.com/JamesIves/github-pages-deploy-action/wiki
🔧 Support: https://github.com/JamesIves/github-pages-deploy-action/issues
Contribute: https://github.com/JamesIves/github-pages-deploy-action/blob/dev/CONTRIBUTING.md
Maintainer: James Ives (https://jamesiv.es)`)
info('Checking configuration and starting deployment… 🚦') info('Checking configuration and starting deployment… 🚦')
const settings = { const settings = {