-
Notifications
You must be signed in to change notification settings - Fork 206
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: Add 10UP Deploy #2469
base: develop
Are you sure you want to change the base?
chore: Add 10UP Deploy #2469
Conversation
WalkthroughThis pull request introduces two significant changes: the addition of a Changes
Assessment against linked issues
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
🧹 Outside diff range and nitpick comments (3)
.github/workflows/deploy.yml (3)
3-6
: Consider restricting tag pattern to semantic versioningThe current configuration triggers on any tag. Consider restricting it to semantic versioning pattern to prevent accidental deployments.
on: push: tags: - - "*" + - "v[0-9]+.[0-9]+.[0-9]+*"
20-24
: Optimize npm installation and build processConsider adding npm caching and version pinning for faster and more reliable builds.
+ - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: '18' + cache: 'npm' - name: Build run: | composer install --no-dev - npm install + npm ci npm run build
1-50
: Consider adding post-deployment verification and notificationsTo enhance the deployment workflow, consider:
- Adding a post-deployment verification step to ensure the plugin is accessible on WordPress.org
- Implementing Slack/Discord notifications for deployment status
- Adding timeout configurations for long-running steps
- Implementing retry logic for potentially flaky operations
Would you like assistance in implementing any of these improvements?
🧰 Tools
🪛 actionlint (1.7.4)
13-13: the runner of "actions/checkout@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
46-46: the runner of "softprops/action-gh-release@v1" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (23)
.wordpress-org/banner-1544x500.png
is excluded by!**/*.png
.wordpress-org/banner-772x250.png
is excluded by!**/*.png
.wordpress-org/icon-128x128.gif
is excluded by!**/*.gif
.wordpress-org/icon-256x256.gif
is excluded by!**/*.gif
.wordpress-org/screenshot-1.png
is excluded by!**/*.png
.wordpress-org/screenshot-10.png
is excluded by!**/*.png
.wordpress-org/screenshot-11.png
is excluded by!**/*.png
.wordpress-org/screenshot-12.png
is excluded by!**/*.png
.wordpress-org/screenshot-13.png
is excluded by!**/*.png
.wordpress-org/screenshot-14.png
is excluded by!**/*.png
.wordpress-org/screenshot-15.png
is excluded by!**/*.png
.wordpress-org/screenshot-16.png
is excluded by!**/*.png
.wordpress-org/screenshot-17.png
is excluded by!**/*.png
.wordpress-org/screenshot-18.png
is excluded by!**/*.png
.wordpress-org/screenshot-19.png
is excluded by!**/*.png
.wordpress-org/screenshot-2.png
is excluded by!**/*.png
.wordpress-org/screenshot-3.png
is excluded by!**/*.png
.wordpress-org/screenshot-4.png
is excluded by!**/*.png
.wordpress-org/screenshot-5.png
is excluded by!**/*.png
.wordpress-org/screenshot-6.png
is excluded by!**/*.png
.wordpress-org/screenshot-7.png
is excluded by!**/*.png
.wordpress-org/screenshot-8.png
is excluded by!**/*.png
.wordpress-org/screenshot-9.png
is excluded by!**/*.png
📒 Files selected for processing (2)
.distignore
(1 hunks).github/workflows/deploy.yml
(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- .distignore
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/deploy.yml
13-13: the runner of "actions/checkout@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
46-46: the runner of "softprops/action-gh-release@v1" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
🔇 Additional comments (3)
.github/workflows/deploy.yml (3)
25-28
: LGTM!
The SVN installation steps are properly implemented with update and install commands.
38-44
: LGTM!
The asset update configuration is properly implemented with appropriate settings.
29-37
: LGTM! Verify secrets configuration
The deployment configuration looks good with proper secret handling.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pls consult with @getdokan/product to update images.
@mrabbani vai, I have already given a task to marketing team to provide me some updated image of dokan plugin for wp org few days back and probably they will provide the images to me on next week. If this 10UP related deployment dependency is very urgent then kindly proceed onto that for now. Once the updated screenshot images will be available to me I will provide those resources at that time and on following deployment images can be updated as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pls check CodeRabbit recommendations for the version of Github actions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
♻️ Duplicate comments (1)
.github/workflows/deploy.yml (1)
14-19
:⚠️ Potential issueUpdate PHP version to supported release
PHP 7.4 has reached end of life. Consider updating to a supported PHP version (8.1 or 8.2) for security and performance benefits.
- name: Setup PHP 7.4 uses: shivammathur/setup-php@v2 with: - php-version: '7.4' + php-version: '8.1' coverage: none tools: composer:v2
🧹 Nitpick comments (6)
.github/workflows/deploy.yml (6)
3-6
: Restrict tag pattern for deploymentsThe current trigger runs on any tag push. Consider restricting it to semantic version tags to prevent accidental deployments.
on: push: tags: - - "*" + - "v[0-9]+.[0-9]+.[0-9]+*"
20-24
: Optimize build performanceConsider adding npm caching and specifying the npm version for consistent builds.
+ - name: Setup Node.js + uses: actions/setup-node@v4 + with: + node-version: '18' + cache: 'npm' - name: Build run: | composer install --no-dev npm install npm run build
29-37
: Improve deployment configuration robustnessConsider these improvements:
- Add pre-job checks for required secrets
- Make the SLUG configurable through repository settings
+ - name: Check required secrets + run: | + if [ -z "${{ secrets.SVN_USERNAME }}" ] || [ -z "${{ secrets.SVN_PASSWORD }}" ]; then + echo "::error::Missing required secrets SVN_USERNAME and/or SVN_PASSWORD" + exit 1 + fi - name: WordPress Plugin Deploy id: deploy uses: 10up/action-wordpress-plugin-deploy@stable with: generate-zip: true env: SVN_USERNAME: ${{ secrets.SVN_USERNAME }} SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }} - SLUG: dokan-lite + SLUG: ${{ vars.WP_PLUGIN_SLUG || 'dokan-lite' }}
38-44
: Maintain consistency with deployment configurationApply the same SLUG configuration improvement as the deployment step.
env: SVN_PASSWORD: ${{ secrets.SVN_PASSWORD }} SVN_USERNAME: ${{ secrets.SVN_USERNAME }} IGNORE_OTHER_FILES: true - SLUG: dokan-lite + SLUG: ${{ vars.WP_PLUGIN_SLUG || 'dokan-lite' }}
45-50
: Enhance GitHub release automationConsider these improvements:
- Use a more reliable path for the zip file
- Add automated changelog generation
- name: Create GitHub release uses: softprops/action-gh-release@v2 with: - files: ${{github.workspace}}/${{ github.event.repository.name }}.zip + files: ${{ steps.deploy.outputs.zip_path }} + generate_release_notes: true env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7-10
: Add workflow-level safeguardsConsider adding concurrency control and timeout limits to prevent deployment conflicts and hanging jobs.
jobs: + # Prevent concurrent deployments + concurrency: + group: "deploy-${{ github.ref }}" + cancel-in-progress: true releaseToWPOrg: name: Release to WordPress.org runs-on: ubuntu-latest + timeout-minutes: 15
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/deploy.yml
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: e2e tests (3, 3)
- GitHub Check: e2e tests (2, 3)
- GitHub Check: e2e tests (1, 3)
- GitHub Check: api tests (1, 1)
To Concerns, Here is the drive folder where you will find the screenshots which need to be updated in wp org. Folder: Drive Folder Link
Please update this according to requirement while releasing a version cc: @mrabbani vai @shohag121 vai |
All Submissions:
Changes proposed in this Pull Request:
Related Pull Request(s)
Closes
How to test the changes in this Pull Request:
Changelog entry
Title
Detailed Description of the pull request. What was previous behaviour
and what will be changed in this PR.
Before Changes
Describe the issue before changes with screenshots(s).
After Changes
Describe the issue after changes with screenshot(s).
Feature Video (optional)
Link of detailed video if this PR is for a feature.
PR Self Review Checklist:
FOR PR REVIEWER ONLY:
Summary by CodeRabbit
.distignore
file to streamline the distribution process by excluding unnecessary files and directories.These enhancements improve the efficiency and organization of the plugin's deployment process.