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

Add apidocs action #3183

Merged
merged 3 commits into from
Jul 4, 2020
Merged

Add apidocs action #3183

merged 3 commits into from
Jul 4, 2020

Conversation

paulbalandan
Copy link
Member

@paulbalandan paulbalandan commented Jun 29, 2020

Description
Adds the action to update API docs. I have made this barely working up to Make the new API docs step. The deploy step fails for the username. Perhaps it is because I don't have credentials to push to codeigniter4/api in my testing.

Another is the use of the phar file. I'm more inclined to download the phar file per run rather than maintain the phar in the codebase so as to save disk space. But, I cannot make the download through curl successful. But if you think otherwise, it's fine.

After a series of runs, had finally made this turn green.
Workflow run
API push

Checklist:

  • Securely signed commits
  • Component(s) with PHPdocs
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

@MGatner
Copy link
Member

MGatner commented Jul 3, 2020

@paulbalandan when I was creating the deployment action I forked all the affected repos and modified the organization section of the action so I can test it local to my GitHub account first. Might be a solution if you think there is a permissions issue.

@paulbalandan
Copy link
Member Author

Wow. Thanks! I'll try this later this evening.

@paulbalandan
Copy link
Member Author

I think this is ready. Requesting review from @lonnieezell or @MGatner .

@MGatner
Copy link
Member

MGatner commented Jul 4, 2020

Were you able to test it local to your org? If so could you link action results please?

@paulbalandan
Copy link
Member Author

Kindly see the link above.

@MGatner MGatner merged commit e9afc85 into codeigniter4:develop Jul 4, 2020
@MGatner
Copy link
Member

MGatner commented Jul 4, 2020

“Process exited with code 23”

https://github.com/codeigniter4/CodeIgniter4/actions/runs/157699136

@paulbalandan
Copy link
Member Author

Didn't see that coming. I'll check later in the morning what is missing still.

@MGatner
Copy link
Member

MGatner commented Jul 4, 2020

It could be an issue for @lonnieezell, like ensuring the secret token has access to the API repo.

@paulbalandan paulbalandan deleted the apidocs-action branch July 4, 2020 22:10
@paulbalandan
Copy link
Member Author

Visually inspecting this action's syntax against the green built run in mine, I think the problem is the missing cd ./source before the curl call. Might have overlooked that while copying. I'll send a PR for that later.

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

2 participants