Before you publish a public actor, you should fulfill this checklist. For important main public actors, you should fulfill all the points, for other only the bold ones.
- README.md - Detailed and well structured (check Instagram Scraper and Google Sheets for inspiration).
- Hosted on Github - You should host it on your own Github account.
- Use Apify EsLint
- Use INPUT_SCHEMA
- Well structured - Check this article
- Set Timeout in settings to 604800 seconds
- Example run - Should cover the latest version and common use-case.
- Testing actor - You should build testing actor that will run the main actor on schedule, test it and notify you if it fails the tests.
Nice logs - Logs should be readable and friendly also for non-developers. Avoid flooding the log with unimportant messages. Explain errors if needed. End the log with
Crawler finishedor something similar. (Check for inspiration - Google Sheets).
- Debug logs - Some logs that are only relevant for testing should be coded as debug logs, only displayed in development.
- 2 people review - Find your reviewers on Apify Slack. Find them early, it takes time.
- Nice code - Code should be clean and well structured. Think that other people will read it and build upon it. Split the code into well-named files and functions.
- SEO - Title, description, and README.md should be SEO friendly to promote the actor. Read more in this article.
- Test as a new user - Try to approach your actor as a completely new user. Remember that it is written for others to use.
- Use proper versioning
- Measure CU usage and cost - for basic use-cases and create a table for it in the README.md
- Blog post(optional) - Write a blog post on Medium that will introduce the actor and guide the users through basic use-case.
- Tweet - Done by Apify marketing team.
- Newsletter - Done by Apify marketing team.